UnitList
extends Summary
in package
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
- $entryHelper : EntryHelper
- $entryQueryHelper : EntryQueryHelper
- $Get : Field
- $identifier : string|null
- $mbid : int|null
- $mid : int|null
- $moduleContext : Field
- $Post : Field_Validation
- $scopes : mixed
- $unitListHelper : UnitListHelper
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>
- 基本カスタムフィールドを組み立て
- buildEntries() : array<string|int, mixed>
- テンプレートの組み立て
- buildFieldTrait() : array<string|int, mixed>|null
- フィールドを連想配列として組み立て
- buildModuleContext() : void
- モジュールコンテキストを組み立て
- buildModuleField() : null|array<string|int, mixed>
- モジュールフィールドを組み立て
- buildMultiFieldGroupTrait() : array<string|int, mixed>
- 複数項目をもつカスタムフィールドグループを組み立て
- buildMultiFieldTrait() : array<string|int, mixed>
- 複数項目をもつカスタムフィールドを組み立て
- buildPagination() : array<string|int, mixed>|null
- ページネーションの組み立て
- buildQuery() : SQL_Select
- クエリの組み立て
- buildRootVars() : array<string|int, mixed>|null
- ルート変数の組み立て
- buildSimplePager() : array<string|int, mixed>|null
- シンプルページャーの組み立て
- buildUnit() : array<string|int, mixed>
- テンプレートの組み立て
- categoryAxis() : string
- exec() : array<string|int, mixed>
- モジュールを実行結果を返却（キャッシュ考慮）
- extractGroupFieldKeysTrait() : array<string|int, mixed>
- グループフィールドのキーを抜き出す
- extractNonGroupFieldKeysTrait() : array<string|int, mixed>
- グループフィールドのキーを除いてキーを取得
- fixVars() : array<string|int, mixed>
- 変数の修正
- formatFieldKeysTrait() : array<string|int, mixed>
- フィールドキー配列を整形
- getBaseParams() : array<string|int, mixed>
- モジュールの基本パラメータを取得
- getEntries() : array<string|int, mixed>
- エントリの取得
- getScope() : string
- 指定したコンテキストのスコープを取得 モジュール設定とURLのコンテキストを考慮します
- initConfig() : array{order: array{string}, limit: int, offset: 0, paginationEnabled: bool, paginationDelta: int, includeEntry: bool, includeEntryFields: bool, includeCategory: bool, includeCategoryFields: bool, includeUser: bool, includeUserFields: bool, includeBlog: bool, includeBlogFields: bool}
- コンフィグの取得
- loadModuleConfig() : Field
- モジュールIDのコンフィグをロード
- notFoundStatus() : void
- Not Found ステータスの設定
- preBuild() : array<string|int, mixed>
- ビルド前のカスタム処理
- 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
$Field
public
Field_Search
$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
$cacheLifetime
protected
int
$cacheLifetime
= 0
$config
protected
array<string, mixed>
$config
= []
$customFieldsEnabled
protected
bool
$customFieldsEnabled
= false
$entryHelper
protected
EntryHelper
$entryHelper
$entryQueryHelper
protected
EntryQueryHelper
$entryQueryHelper
$Get
protected
Field
$Get
$identifier
protected
string|null
$identifier
= null
$mbid
protected
int|null
$mbid
= null
$mid
protected
int|null
$mid
= null
$moduleContext
protected
Field
$moduleContext
$Post
protected
Field_Validation
$Post
$scopes
protected
mixed
$scopes
= [
// phpcs:ignore
'cid' => 'global',
'eid' => 'global',
'start' => 'global',
'end' => 'global',
]
Tags
$unitListHelper
protected
UnitListHelper
$unitListHelper
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
Return values
array<string|int, mixed>get()
public
get() : array<string|int, mixed>|never
Tags
Return values
array<string|int, mixed>|neverautoConvertTypeTrait()
自動で型変換
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
stringboot()
起動処理
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>buildEntries()
テンプレートの組み立て
protected
buildEntries(array<string|int, mixed> $entries) : array<string|int, mixed>
Parameters
- $entries : array<string|int, mixed>
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>|nullbuildModuleContext()
モジュールコンテキストを組み立て
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() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullbuildQuery()
クエリの組み立て
protected
buildQuery() : SQL_Select
Return values
SQL_SelectbuildRootVars()
ルート変数の組み立て
protected
buildRootVars() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullbuildSimplePager()
シンプルページャーの組み立て
protected
buildSimplePager(bool $hasNextPage) : array<string|int, mixed>|null
Parameters
- $hasNextPage : bool
Return values
array<string|int, mixed>|nullbuildUnit()
テンプレートの組み立て
protected
buildUnit(array<string|int, mixed> $unitData) : array<string|int, mixed>
Parameters
- $unitData : array<string|int, mixed>
Return values
array<string|int, mixed>categoryAxis()
protected
categoryAxis() : string
Return values
stringexec()
モジュールを実行結果を返却（キャッシュ考慮）
protected
exec() : array<string|int, mixed>
Tags
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>fixVars()
変数の修正
protected
fixVars(array<string|int, mixed> $vars) : array<string|int, mixed>
Parameters
- $vars : 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>getEntries()
エントリの取得
protected
getEntries(SQL_Select $sql) : array<string|int, mixed>
Parameters
- $sql : SQL_Select
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
stringinitConfig()
コンフィグの取得
protected
initConfig() : array{order: array{string}, limit: int, offset: 0, paginationEnabled: bool, paginationDelta: int, includeEntry: bool, includeEntryFields: bool, includeCategory: bool, includeCategoryFields: bool, includeUser: bool, includeUserFields: bool, includeBlog: bool, includeBlogFields: bool}
Return values
array{order: array{string}, limit: int, offset: 0, paginationEnabled: bool, paginationDelta: int, includeEntry: bool, includeEntryFields: bool, includeCategory: bool, includeCategoryFields: bool, includeUser: bool, includeUserFields: bool, includeBlog: bool, includeBlogFields: bool}loadModuleConfig()
モジュールIDのコンフィグをロード
protected
loadModuleConfig() : Field
Return values
FieldnotFoundStatus()
Not Found ステータスの設定
protected
notFoundStatus(array<string|int, mixed> $entries) : void
Parameters
- $entries : array<string|int, mixed>
preBuild()
ビルド前のカスタム処理
protected
preBuild(array<string|int, mixed> $vars, array<string|int, mixed> $entries) : array<string|int, mixed>
Parameters
- $vars : array<string|int, mixed>
- $entries : array<string|int, mixed>
Return values
array<string|int, mixed>setConfigTrait()
コンフィグのセット
protected
setConfigTrait() : bool
Return values
boolsetIntegerValue()
整数型の値を設定
protected
setIntegerValue(string $key) : void
Parameters
- $key : string