a-blog cms PHP API Reference

Helper
in package
uses EagerLoadingTrait, UnitMultiLangTrait

Table of Contents

Methods

buildAdminFormColumn()  : bool
編集ページの動的フォームユニットを組み立て
buildDate()  : array<string, string|false>
日付の組み立て
buildField()  : array<string|int, mixed>
カスタムフィールドの組み立て
buildImage()  : array<string|int, mixed>
画像の組み立て
buildModuleField()  : void
モジュールフィールドの組み立て
buildPager()  : array<string|int, mixed>
ページャーの組み立て
buildRelatedEntries()  : void
関連記事の組み立て
buildRelatedEntriesList()  : mixed
関連記事を組み立て
buildSummary()  : void
サマリーの組み立て
buildSummaryFulltext()  : array<string|int, mixed>
フルテキストの組み立て
buildTag()  : void
タグの組み立て
buildValidationOptionSelect()  : void
バリデーション選択肢のセレクトを group → option のネストループでテンプレートに反映する。
eagerLoadFullText()  : array<int<1, max>, UnitCollection>
フルテキストのEagerLoading ToDo: deplicated mehod Ver. 3.2
eagerLoadMainImage()  : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
メインイメージのEagerLoading ToDo: deplicated mehod Ver. 3.2
eagerLoadRelatedEntry()  : array<string|int, mixed>
関連記事のEagerLoading ToDo: deplicated mehod Ver. 3.2
eagerLoadTag()  : array<string|int, mixed>
タグのEagerLoading ToDo: deplicated mehod Ver. 3.2
explodeUnitDataTrait()  : array<string|int, mixed>
ユニットのデータを分割する
form2ValidationOptionGroups()  : array<int, array{group: string, label: string, options: array}>
フォーム2 用のバリデーション選択肢グループを取得する。
formatMultiLangUnitDataTrait()  : mixed
ユニットのデータを多言語ユニットを考慮して整形する
implodeUnitDataTrait()  : string
ユニットのデータを結合する
injectBlockEditorField()  : void
ブロックエディタフィールドの注入
injectMediaField()  : mixed
injectRichEditorField()  : mixed
removeMultiLangUnitDelimiterTrait()  : string
多言語ユニット用のデリミタを削除する
spreadModule()  : string
レイアウトモジュールの1モジュールを組み立て
validationOptionGroups()  : array<int, array{group: string, label: string, options: array}>
管理画面のバリデーション選択肢グループを取得する。 excludeKeys に指定したオプションは、その画面の都合（送信処理が未対応など）で選択肢から除外する。
buildInputCheckboxChecked()  : array<string|int, mixed>
チェックボックスインプットの組み立て
buildInputTextValue()  : array<string|int, mixed>
テキストインプットの組み立て
buildSelectSelected()  : array<string|int, mixed>
セレクトボックスインプットの組み立て
eagerLoadEntryTrait()  : array<int, array<string, mixed>>
エントリーのEagerLoading
eagerLoadFieldTrait()  : Field>)
eagerLoadFullTextTrait()  : array<int<1, max>, UnitCollection>
フルテキストのEagerLoading
eagerLoadMainImageFieldTrait()  : array<int, array<string|int, mixed>>
指定したエントリーカスタムフィールドのメインイメージをEagerLoadする
eagerLoadMainImageTrait()  : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
メインイメージのEagerLoading
eagerLoadRelatedEntryTrait()  : array<string|int, mixed>
関連記事のEagerLoading
eagerLoadSubCategoriesTrait()  : array<string|int, array<int, array<string, mixed>>>
サブカテゴリーのEagerLoading
eagerLoadTagTrait()  : array<string|int, mixed>
タグのEagerLoading

Methods

buildAdminFormColumn()

編集ページの動的フォームユニットを組み立て

public buildAdminFormColumn(array<string|int, mixed> $data, ViewInterface $Tpl[, array<string|int, string>|string $rootBlock = [] ]) : bool
Parameters
$data : array<string|int, mixed>
$Tpl : ViewInterface
$rootBlock : array<string|int, string>|string = []
Return values
bool

buildDate()

日付の組み立て

public buildDate(int|string $datetime, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ][, string $prefix = 'date#' ]) : array<string, string|false>
Parameters
$datetime : int|string
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
$prefix : string = 'date#'
Return values
array<string, string|false>

buildField()

カスタムフィールドの組み立て

public buildField(Field $Field, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ][, string|null $scp = null ][, array<string|int, mixed> $loop_vars = [] ]) : array<string|int, mixed>
Parameters
$Field : Field
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
$scp : string|null = null
$loop_vars : array<string|int, mixed> = []
Return values
array<string|int, mixed>

buildImage()

画像の組み立て

public buildImage(ViewInterface $Tpl, int $entryId, string $pimageId, array{imageX: int, imageY: int, imageTrim?: bool|"on"|"off", imageZoom?: bool|"on"|"off", imageCenter?: bool|"on"|"off"} $config, Model>, media: array>, fieldMainImage?: array>} $eagerLoadingData) : array<string|int, mixed>
Parameters
$Tpl : ViewInterface
$entryId : int
$pimageId : string
$config : array{imageX: int, imageY: int, imageTrim?: bool|"on"|"off", imageZoom?: bool|"on"|"off", imageCenter?: bool|"on"|"off"}
$eagerLoadingData : Model>, media: array>, fieldMainImage?: array>}
Return values
array<string|int, mixed>

buildModuleField()

モジュールフィールドの組み立て

public buildModuleField(ViewInterface $Tpl[, int|null $mid = null ][, bool $show = false ]) : void
Parameters
$Tpl : ViewInterface
$mid : int|null = null
$show : bool = false

buildPager()

ページャーの組み立て

public buildPager(int $page, int $limit, int $amount, int $delta, string $curAttr, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ][, array<string|int, mixed> $Q = [] ]) : array<string|int, mixed>
Parameters
$page : int

ページ数

$limit : int

1ページの件数

$amount : int

総数

$delta : int

前後ページ数

$curAttr : string
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
$Q : array<string|int, mixed> = []
Return values
array<string|int, mixed>

buildRelatedEntries()

関連記事の組み立て

public buildRelatedEntries(ViewInterface $Tpl, array<string|int, int> $eids, array<string|int, string>|string $block, string $start, string $end[, string $relatedBlock = 'related:loop' ][, string|null $thumbnailField = '' ]) : void
Parameters
$Tpl : ViewInterface
$eids : array<string|int, int>
$block : array<string|int, string>|string
$start : string
$end : string
$relatedBlock : string = 'related:loop'
$thumbnailField : string|null = ''

buildRelatedEntriesList()

関連記事を組み立て

public buildRelatedEntriesList(ViewInterface $Tpl, int $eid, array<int, array<string, array<string|int, array<string|int, mixed>>>> $eagerLoadingData[, array<string|int, string>|string $block = [] ]) : mixed
Parameters
$Tpl : ViewInterface
$eid : int
$eagerLoadingData : array<int, array<string, array<string|int, array<string|int, mixed>>>>
$block : array<string|int, string>|string = []

buildSummary()

サマリーの組み立て

public buildSummary(ViewInterface $Tpl, array<string|int, mixed> $row, int $count, int $gluePoint, array<string|int, mixed> $config[, array<string|int, mixed> $extraVars = [] ][, int $page = 1 ][, array<string|int, mixed> $eagerLoadingData = [] ]) : void
Parameters
$Tpl : ViewInterface
$row : array<string|int, mixed>
$count : int
$gluePoint : int
$config : array<string|int, mixed>
$extraVars : array<string|int, mixed> = []
$page : int = 1
$eagerLoadingData : array<string|int, mixed> = []

buildSummaryFulltext()

フルテキストの組み立て

public buildSummaryFulltext(array<string|int, mixed> $vars, int $eid, array<int<1, max>, UnitCollection> $eagerLoadingData) : array<string|int, mixed>
Parameters
$vars : array<string|int, mixed>
$eid : int
$eagerLoadingData : array<int<1, max>, UnitCollection>
Return values
array<string|int, mixed>

buildTag()

タグの組み立て

public buildTag(ViewInterface $tpl, int $eid, array<string|int, mixed> $eagerLoadingData[, array<string|int, string> $blocks = [] ]) : void
Parameters
$tpl : ViewInterface
$eid : int
$eagerLoadingData : array<string|int, mixed>
$blocks : array<string|int, string> = []

buildValidationOptionSelect()

バリデーション選択肢のセレクトを group → option のネストループでテンプレートに反映する。

public buildValidationOptionSelect(ViewInterface|Template $Tpl, array<int, array{group: string, label: string, options: array}> $optionGroups, string $groupLoop, string $optionLoop[, array<int, string> $outerBlock = [] ][, string|null $selectedKey = null ]) : void

item-template 用（選択なし）と保存済み行用（選択あり）で、ループブロック名と選択中キーだけを 変えて使い回す共通処理。変数は :loop 以外をドット記法（methodGroup.label など）で渡す。

Parameters
$Tpl : ViewInterface|Template
$optionGroups : array<int, array{group: string, label: string, options: array}>
$groupLoop : string

グループのループブロック名（例: 'methodGroup:loop'）

$optionLoop : string

オプションのループブロック名（例: 'methodOption:loop'）

$outerBlock : array<int, string> = []

groupLoop の外側のブロックパス（例: ['option:loop']）

$selectedKey : string|null = null

選択中のオプションキー。一致する option に selected を付与する

eagerLoadFullText()

フルテキストのEagerLoading ToDo: deplicated mehod Ver. 3.2

public eagerLoadFullText(array<string|int, int> $entryIds) : array<int<1, max>, UnitCollection>
Parameters
$entryIds : array<string|int, int>
Return values
array<int<1, max>, UnitCollection>

eagerLoadMainImage()

メインイメージのEagerLoading ToDo: deplicated mehod Ver. 3.2

public eagerLoadMainImage(mixed $entries[, mixed $target = 'unit' ][, mixed $fieldName = '' ]) : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
Parameters
$entries : mixed
$target : mixed = 'unit'

?'unit'|'field'

$fieldName : mixed = ''

?string

Return values
, media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})

eagerLoadRelatedEntry()

関連記事のEagerLoading ToDo: deplicated mehod Ver. 3.2

public eagerLoadRelatedEntry(mixed $eidArray) : array<string|int, mixed>
Parameters
$eidArray : mixed

array

Return values
array<string|int, mixed>

eagerLoadTag()

タグのEagerLoading ToDo: deplicated mehod Ver. 3.2

public eagerLoadTag(array<string|int, int> $eidArray) : array<string|int, mixed>
Parameters
$eidArray : array<string|int, int>
Return values
array<string|int, mixed>

explodeUnitDataTrait()

ユニットのデータを分割する

public explodeUnitDataTrait(mixed $data) : array<string|int, mixed>

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters
$data : mixed
Return values
array<string|int, mixed>

form2ValidationOptionGroups()

フォーム2 用のバリデーション選択肢グループを取得する。

public form2ValidationOptionGroups() : array<int, array{group: string, label: string, options: array}>

フォーム2 の送信処理は filesize / duplication / all_unique を扱わないため、それらを選択肢から除外する。 除外対象はこのメソッドに集約し、呼び出し側（GET ハンドラ・カラムビルド）で重複させない。

Return values
array<int, array{group: string, label: string, options: array}>

formatMultiLangUnitDataTrait()

ユニットのデータを多言語ユニットを考慮して整形する

public formatMultiLangUnitDataTrait(mixed $data[, array<string|int, mixed> &$vars = [] ][, string $name = '' ]) : mixed

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters
$data : mixed
$vars : array<string|int, mixed> = []
$name : string = ''

implodeUnitDataTrait()

ユニットのデータを結合する

public implodeUnitDataTrait(array<string|int, string>|string $data) : string

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters
$data : array<string|int, string>|string
Return values
string

injectBlockEditorField()

ブロックエディタフィールドの注入

public injectBlockEditorField(Field $Field[, bool $resizeImage = true ]) : void
Parameters
$Field : Field
$resizeImage : bool = true

injectMediaField()

public injectMediaField(mixed $Field[, mixed $force = false ]) : mixed
Parameters
$Field : mixed
$force : mixed = false

injectRichEditorField()

public injectRichEditorField(mixed $Field[, mixed $force = true ]) : mixed
Parameters
$Field : mixed
$force : mixed = true

removeMultiLangUnitDelimiterTrait()

多言語ユニット用のデリミタを削除する

public removeMultiLangUnitDelimiterTrait(string $text) : string

多言語ユニットは非推奨です。新規ユニットは多言語対応していません。

Parameters
$text : string
Return values
string

spreadModule()

レイアウトモジュールの1モジュールを組み立て

public spreadModule(string $moduleName, string $moduleID, string $moduleTpl[, bool $onlyLayout = false ]) : string
Parameters
$moduleName : string
$moduleID : string
$moduleTpl : string
$onlyLayout : bool = false
Return values
string

validationOptionGroups()

管理画面のバリデーション選択肢グループを取得する。 excludeKeys に指定したオプションは、その画面の都合（送信処理が未対応など）で選択肢から除外する。

public validationOptionGroups([array<int, string> $excludeKeys = [] ]) : array<int, array{group: string, label: string, options: array}>
Parameters
$excludeKeys : array<int, string> = []

この画面では出さないオプションキー

Return values
array<int, array{group: string, label: string, options: array}>

buildInputCheckboxChecked()

チェックボックスインプットの組み立て

protected buildInputCheckboxChecked(array<string|int, mixed> $data, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
Return values
array<string|int, mixed>

buildInputTextValue()

テキストインプットの組み立て

protected buildInputTextValue(array<string|int, mixed> $data, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
Return values
array<string|int, mixed>

buildSelectSelected()

セレクトボックスインプットの組み立て

protected buildSelectSelected(array<string|int, mixed> $data, ViewInterface $Tpl[, array<string|int, string>|string $block = [] ]) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>
$Tpl : ViewInterface
$block : array<string|int, string>|string = []
Return values
array<string|int, mixed>

eagerLoadEntryTrait()

エントリーのEagerLoading

protected eagerLoadEntryTrait(array<string|int, int> $ids) : array<int, array<string, mixed>>
Parameters
$ids : array<string|int, int>
Return values
array<int, array<string, mixed>>

eagerLoadFieldTrait()

protected eagerLoadFieldTrait(array<string|int, int>|array<string|int, string> $ids, "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id" $type[, int|null $rvid = null ]) : Field>)
Parameters
$ids : array<string|int, int>|array<string|int, string>
$type : "eid"|"uid"|"bid"|"cid"|"mid"|"unit_id"
$rvid : int|null = null
Return values
Field>)

eagerLoadFullTextTrait()

フルテキストのEagerLoading

protected eagerLoadFullTextTrait(array<string|int, int> $entryIds) : array<int<1, max>, UnitCollection>
Parameters
$entryIds : array<string|int, int>
Return values
array<int<1, max>, UnitCollection>

eagerLoadMainImageFieldTrait()

指定したエントリーカスタムフィールドのメインイメージをEagerLoadする

protected eagerLoadMainImageFieldTrait(array<string|int, mixed> $entryIds, string $fieldName[, int|null $rvid = null ]) : array<int, array<string|int, mixed>>
Parameters
$entryIds : array<string|int, mixed>
$fieldName : string
$rvid : int|null = null
Return values
array<int, array<string|int, mixed>>

eagerLoadMainImageTrait()

メインイメージのEagerLoading

protected eagerLoadMainImageTrait(mixed $entries[, mixed $target = 'unit' ][, mixed $fieldName = '' ][, int|null $rvid = null ]) : , media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})
Parameters
$entries : mixed
$target : mixed = 'unit'

'unit'|'field'

$fieldName : mixed = ''

?string

$rvid : int|null = null
Return values
, media: array, fieldMainImage: array} : array{unit: array, media: array})">Model>, media: array})

eagerLoadRelatedEntryTrait()

関連記事のEagerLoading

protected eagerLoadRelatedEntryTrait(array<string|int, int> $eidArray) : array<string|int, mixed>
Parameters
$eidArray : array<string|int, int>
Return values
array<string|int, mixed>

eagerLoadSubCategoriesTrait()

サブカテゴリーのEagerLoading

protected eagerLoadSubCategoriesTrait(array<string|int, int> $eidArray[, null|int $rvid = null ]) : array<string|int, array<int, array<string, mixed>>>
Parameters
$eidArray : array<string|int, int>
$rvid : null|int = null
Return values
array<string|int, array<int, array<string, mixed>>>

eagerLoadTagTrait()

タグのEagerLoading

protected eagerLoadTagTrait(array<string|int, int> $eidArray[, int|null $rvid = null ]) : array<string|int, mixed>
Parameters
$eidArray : array<string|int, int>
$rvid : int|null = null
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results