a-blog cms PHP API Reference

MoreContent extends Body
in package
uses ConfigTrait

Table of Contents

Properties

$bid  : int
$bids  : array<string|int, int>
$cid  : int|null
$cids  : array<string|int, int>
$eid  : int|null
$eids  : array<string|int, int>
$end  : string
$field  : string
$Field  : Field_Search
$keyword  : string
$limit  : int|null
$order  : string
$page  : int<1, max>
$start  : string
$tag  : string
$tags  : array<string|int, string>
$uid  : int|null
$uids  : array<string|int, int>
$axis  : mixed
階層の設定
$cacheLifetime  : int
$config  : array<string, mixed>
$customFieldsEnabled  : bool
$entries  : array<string|int, mixed>
$entryBodyHelper  : EntryBodyHelper
$entryHelper  : EntryHelper
$entryQueryHelper  : EntryQueryHelper
$Get  : Field
$identifier  : string|null
$mbid  : int|null
$mid  : int|null
$moduleContext  : Field
$Post  : Field_Validation
$scopes  : array{uid?: "local"|"global", cid?: "local"|"global", eid?: "local"|"global", keyword?: "local"|"global", tag?: "local"|"global", field?: "local"|"global", date?: "local"|"global", start?: "local"|"global", end?: "local"|"global", page?: "local"|"global", order?: "local"|"global"}
スコープの設定

Methods

__construct()  : void
Constructor
fire()  : array<string|int, mixed>
モジュールを実行
get()  : array<string|int, mixed>|never
autoConvertTypeTrait()  : array<string|int, mixed>
自動で型変換
blogAxis()  : string
boot()  : void
起動処理
buildAxis()  : void
モジュールの階層設定を組み立て
buildBasicFieldGroupTrait()  : array<string|int, mixed>
基本カスタムフィールドグループを組み立て
buildBasicFieldTrait()  : array<string|int, mixed>
基本カスタムフィールドを組み立て
buildEditorialInfo()  : null|array<string|int, mixed>
編集情報を組み立て
buildEntry()  : array<string|int, mixed>
エントリー1件を組み立てs
buildEntryIndex()  : array<string|int, mixed>
エントリー一覧を組み立て
buildFieldTrait()  : array<string|int, mixed>|null
フィールドを連想配列として組み立て
buildMicroPagination()  : null|array<string|int, mixed>
マイクロページネーションを組み立て
buildModuleContext()  : void
モジュールコンテキストを組み立て
buildModuleField()  : null|array<string|int, mixed>
モジュールフィールドを組み立て
buildMultiFieldGroupTrait()  : array<string|int, mixed>
複数項目をもつカスタムフィールドグループを組み立て
buildMultiFieldTrait()  : array<string|int, mixed>
複数項目をもつカスタムフィールドを組み立て
buildPagination()  : null|array<string|int, mixed>
ページネーションを組み立て
buildUnitHtml()  : string
ユニットのHTMLを組み立て
categoryAxis()  : string
eagerLoadEntryBody()  : array<string|int, mixed>
Eager Loading
entryIndex()  : array<string|int, mixed>
エントリー一覧ページ
entryPage()  : array<string|int, mixed>
エントリー詳細ページ
exec()  : array<string|int, mixed>
モジュールを実行結果を返却(キャッシュ考慮)
extractGroupFieldKeysTrait()  : array<string|int, mixed>
グループフィールドのキーを抜き出す
extractNonGroupFieldKeysTrait()  : array<string|int, mixed>
グループフィールドのキーを除いてキーを取得
formatFieldKeysTrait()  : array<string|int, mixed>
フィールドキー配列を整形
getBaseParams()  : array<string|int, mixed>
モジュールの基本パラメータを取得
getScope()  : string
指定したコンテキストのスコープを取得 モジュール設定とURLのコンテキストを考慮します
getUnitHtml()  : string
続きを読む以下のユニットのHTMLを取得
getUnitTemplate()  : string
ユニットテンプレートを取得
initConfig()  : array{customField: bool}
コンフィグの取得
isFormVisible()  : bool
動的フォームを表示するかどうか
loadModuleConfig()  : Field
モジュールIDのコンフィグをロード
setConfigTrait()  : bool
コンフィグのセット
setIntegerValue()  : void
整数型の値を設定

Properties

$bid

public int $bid = null

$bids

public array<string|int, int> $bids = []

$cid

public int|null $cid = null

$cids

public array<string|int, int> $cids = []

$eid

public int|null $eid = null

$eids

public array<string|int, int> $eids = []

$end

public string $end

$field

public string $field

$keyword

public string $keyword

$limit

public int|null $limit = null

$order

public string $order

$page

public int<1, max> $page = 1

$start

public string $start

$tag

public string $tag

$tags

public array<string|int, string> $tags = []

$uid

public int|null $uid = null

$uids

public array<string|int, int> $uids = []

$axis

階層の設定

protected mixed $axis = [ // phpcs:ignore 'bid' => 'descendant-or-self', 'cid' => 'descendant-or-self', ]
Tags
inheritDoc

$cacheLifetime

protected int $cacheLifetime = 0

$customFieldsEnabled

protected bool $customFieldsEnabled = false

$entries

protected array<string|int, mixed> $entries = []

$identifier

protected string|null $identifier = null

$mbid

protected int|null $mbid = null

$mid

protected int|null $mid = null

$scopes

スコープの設定

protected array{uid?: "local"|"global", cid?: "local"|"global", eid?: "local"|"global", keyword?: "local"|"global", tag?: "local"|"global", field?: "local"|"global", date?: "local"|"global", start?: "local"|"global", end?: "local"|"global", page?: "local"|"global", order?: "local"|"global"} $scopes = [ // phpcs:ignore 'uid' => 'global', 'cid' => 'global', 'eid' => 'global', 'keyword' => 'global', 'tag' => 'global', 'field' => 'global', 'date' => 'global', 'start' => 'global', 'end' => 'global', 'page' => 'global', ]
Tags
inheritDoc

Methods

__construct()

Constructor

public __construct(array{bid?: int, bids?: int[], cid?: int, cids?: int[], eid?: int, eids?: int[], uid?: int, uids?: int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string} $context, array<string|int, mixed> $scopes, array<string|int, mixed> $axis, Field_Validation $Post[, int $cacheLifetime = 0 ][, bool $customFieldsEnabled = false ][, null|int $mid = null ][, int|null $mbid = null ][, null|string $identifier = null ]) : void
Parameters
$context : array{bid?: int, bids?: int[], cid?: int, cids?: int[], eid?: int, eids?: int[], uid?: int, uids?: int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string}
$scopes : array<string|int, mixed>
$axis : array<string|int, mixed>
$Post : Field_Validation
$cacheLifetime : int = 0
$customFieldsEnabled : bool = false
$mid : null|int = null
$mbid : int|null = null
$identifier : null|string = null

fire()

モジュールを実行

public fire() : array<string|int, mixed>
Tags
throws
BadMethodCallException
Return values
array<string|int, mixed>

get()

public get() : array<string|int, mixed>|never
Tags
inheritDoc
Return values
array<string|int, mixed>|never

autoConvertTypeTrait()

自動で型変換

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

blogAxis()

protected blogAxis() : string
Return values
string

boot()

起動処理

protected boot() : void

buildAxis()

モジュールの階層設定を組み立て

protected buildAxis(array<string|int, mixed> $axis) : void
Parameters
$axis : array<string|int, mixed>

buildBasicFieldGroupTrait()

基本カスタムフィールドグループを組み立て

protected buildBasicFieldGroupTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>
Parameters
$keys : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>
Return values
array<string|int, mixed>

buildBasicFieldTrait()

基本カスタムフィールドを組み立て

protected buildBasicFieldTrait(array<string|int, mixed> $keys, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>
Parameters
$keys : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>
Return values
array<string|int, mixed>

buildEditorialInfo()

編集情報を組み立て

protected buildEditorialInfo(array<string|int, mixed> $entry) : null|array<string|int, mixed>
Parameters
$entry : array<string|int, mixed>
Return values
null|array<string|int, mixed>

buildEntry()

エントリー1件を組み立てs

protected buildEntry(array<string|int, mixed> $entry, array<string|int, mixed> $eagerLoaded) : array<string|int, mixed>
Parameters
$entry : array<string|int, mixed>
$eagerLoaded : array<string|int, mixed>
Return values
array<string|int, mixed>

buildEntryIndex()

エントリー一覧を組み立て

protected buildEntryIndex() : array<string|int, mixed>
Tags
throws
Exception
Return values
array<string|int, mixed>

buildFieldTrait()

フィールドを連想配列として組み立て

protected buildFieldTrait(Field|Field_Validation $field[, string|null $scp = null ]) : array<string|int, mixed>|null
Parameters
$field : Field|Field_Validation
$scp : string|null = null
Return values
array<string|int, mixed>|null

buildMicroPagination()

マイクロページネーションを組み立て

protected buildMicroPagination(UnitCollection $collection) : null|array<string|int, mixed>
Parameters
$collection : UnitCollection
Return values
null|array<string|int, mixed>

buildModuleContext()

モジュールコンテキストを組み立て

protected buildModuleContext(array{bid?: int|int[], cid?: int|int[], eid?: int|int[], uid?: int|int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string} $context, array<string|int, mixed> $scopes) : void
Parameters
$context : array{bid?: int|int[], cid?: int|int[], eid?: int|int[], uid?: int|int[], page?: int, limit?: int, keyword?: string, tag?: string, field?: string, order?: string, start?: string, end?: string}
$scopes : array<string|int, mixed>

buildModuleField()

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

protected buildModuleField() : null|array<string|int, mixed>
Return values
null|array<string|int, mixed>

buildMultiFieldGroupTrait()

複数項目をもつカスタムフィールドグループを組み立て

protected buildMultiFieldGroupTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>
Return values
array<string|int, mixed>

buildMultiFieldTrait()

複数項目をもつカスタムフィールドを組み立て

protected buildMultiFieldTrait(array<string|int, mixed> $items, Field|Field_Validation $field, array<string|int, mixed> $initial) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>
$field : Field|Field_Validation
$initial : array<string|int, mixed>
Return values
array<string|int, mixed>

buildPagination()

ページネーションを組み立て

protected buildPagination() : null|array<string|int, mixed>
Return values
null|array<string|int, mixed>

buildUnitHtml()

ユニットのHTMLを組み立て

protected buildUnitHtml(int $eid, UnitCollection $collection, string $tpl) : string
Parameters
$eid : int
$collection : UnitCollection
$tpl : string
Return values
string

categoryAxis()

protected categoryAxis() : string
Return values
string

eagerLoadEntryBody()

Eager Loading

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

entryIndex()

エントリー一覧ページ

protected entryIndex() : array<string|int, mixed>
Tags
throws
NotFoundException
Return values
array<string|int, mixed>

entryPage()

エントリー詳細ページ

protected entryPage() : array<string|int, mixed>
Tags
throws
Exception
throws
NotFoundException
Return values
array<string|int, mixed>

exec()

モジュールを実行結果を返却(キャッシュ考慮)

protected exec() : array<string|int, mixed>
Tags
throws
BadMethodCallException
Return values
array<string|int, mixed>

extractGroupFieldKeysTrait()

グループフィールドのキーを抜き出す

protected extractGroupFieldKeysTrait(Field|Field_Validation $field, array<string|int, mixed> $fieldKeys) : array<string|int, mixed>
Parameters
$field : Field|Field_Validation
$fieldKeys : array<string|int, mixed>
Return values
array<string|int, mixed>

extractNonGroupFieldKeysTrait()

グループフィールドのキーを除いてキーを取得

protected extractNonGroupFieldKeysTrait(array<string|int, mixed> $fieldKeys, array<string|int, mixed> $groupKeys) : array<string|int, mixed>
Parameters
$fieldKeys : array<string|int, mixed>
$groupKeys : array<string|int, mixed>
Return values
array<string|int, mixed>

formatFieldKeysTrait()

フィールドキー配列を整形

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

getBaseParams()

モジュールの基本パラメータを取得

protected getBaseParams([array<string|int, mixed> $override = [] ]) : array<string|int, mixed>
Parameters
$override : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getScope()

指定したコンテキストのスコープを取得 モジュール設定とURLのコンテキストを考慮します

protected getScope(string $key, array<string|int, mixed> $scopes) : string
Parameters
$key : string
$scopes : array<string|int, mixed>
Return values
string

getUnitHtml()

続きを読む以下のユニットのHTMLを取得

protected getUnitHtml(int $eid, int $summaryRange) : string
Parameters
$eid : int
$summaryRange : int
Return values
string

getUnitTemplate()

ユニットテンプレートを取得

protected getUnitTemplate() : string
Return values
string

initConfig()

コンフィグの取得

protected initConfig() : array{customField: bool}
Return values
array{customField: bool}

isFormVisible()

動的フォームを表示するかどうか

protected isFormVisible(array<string|int, mixed> $entry) : bool
Parameters
$entry : array<string|int, mixed>
Return values
bool

loadModuleConfig()

モジュールIDのコンフィグをロード

protected loadModuleConfig() : Field
Return values
Field

setConfigTrait()

コンフィグのセット

protected setConfigTrait() : bool
Return values
bool

setIntegerValue()

整数型の値を設定

protected setIntegerValue(string $key) : void
Parameters
$key : string

        
On this page

Search results