a-blog cms PHP API Reference

TagRelational 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
$tagRelationalHelper  : TagRelationalHelper

Methods

__construct()  : void
Constructor
fire()  : array<string|int, mixed>
モジュールを実行
get()  : array<string|int, mixed>|never
blogAxis()  : string
boot()  : void
起動処理
buildAxis()  : void
モジュールの階層設定を組み立て
buildEntries()  : array<string|int, mixed>
テンプレートの組み立て
buildFieldTrait()  : array<string|int, mixed>|null
フィールドを連想配列として組み立て
buildModuleContext()  : void
モジュールコンテキストを組み立て
buildModuleField()  : null|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
シンプルページャーの組み立て
categoryAxis()  : string
exec()  : array<string|int, mixed>
モジュールを実行結果を返却（キャッシュ考慮）
fixVars()  : array<string|int, mixed>
変数の修正
getBaseParams()  : array<string|int, mixed>
モジュールの基本パラメータを取得
getEntries()  : array<string|int, mixed>
エントリの取得
getScope()  : string
指定したコンテキストのスコープを取得 モジュール設定とURLのコンテキストを考慮します
initConfig()  : array<string, mixed>
コンフィグの取得
loadModuleConfig()  : Field
モジュールIDのコンフィグをロード
moduleCacheEnabled()  : bool
キャッシュを使用すべきかどうかを返す
notFoundStatus()  : void
Not Found ステータスの設定
preBuild()  : array<string|int, mixed>
ビルド前のカスタム処理
resolveTemplateUrlsTrait()  : array<string|int, mixed>
toStructured の出力に対し、path フィールドの URL 解決と html フィールドの 絶対化（テンプレート出力固有）を適用する。
setConfigTrait()  : bool
コンフィグのセット
setIntegerValue()  : void
整数型の値を設定
resolveTemplateUrlsInGroupRowTrait()  : array<string|int, mixed>
グループ内の 1 行に含まれるマルチ項目（連想配列構造）に対して URL 解決を適用。
resolveTemplateUrlsInMultiEntryTrait()  : array<string|int, mixed>
マルチ項目フィールドエントリ（'value'/'array' を持つ）に対して URL 解決を適用。

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' => 'self', 'cid' => 'self', ]

$cacheLifetime

protected int $cacheLifetime = 0

$customFieldsEnabled

protected bool $customFieldsEnabled = false

$identifier

protected string|null $identifier = null

$mbid

protected int|null $mbid = null

$mid

protected int|null $mid = null

$scopes

protected mixed $scopes = ['eid' => '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

blogAxis()

protected blogAxis() : string
Return values
string

buildAxis()

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

protected buildAxis(array<string|int, mixed> $axis) : void
Parameters
$axis : 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

子フィールドとして再帰したときの名前（takeover キーの prefix に使う）

Return values
array<string|int, mixed>|null —

フィールドが空の場合は null

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>

buildPagination()

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

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

buildRootVars()

ルート変数の組み立て

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

buildSimplePager()

シンプルページャーの組み立て

protected buildSimplePager(bool $hasNextPage) : array<string|int, mixed>|null
Parameters
$hasNextPage : bool
Return values
array<string|int, mixed>|null

categoryAxis()

protected categoryAxis() : string
Return values
string

exec()

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

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

fixVars()

変数の修正

protected fixVars(array<string|int, mixed> $vars) : array<string|int, mixed>
Parameters
$vars : array<string|int, mixed>
Tags
inheritDoc
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
string

initConfig()

コンフィグの取得

protected initConfig() : array<string, mixed>
Tags
inheritDoc
Return values
array<string, mixed>

loadModuleConfig()

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

protected loadModuleConfig() : Field
Return values
Field

moduleCacheEnabled()

キャッシュを使用すべきかどうかを返す

protected moduleCacheEnabled() : bool
Return values
bool

notFoundStatus()

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>

resolveTemplateUrlsTrait()

toStructured の出力に対し、path フィールドの URL 解決と html フィールドの 絶対化（テンプレート出力固有）を適用する。

protected resolveTemplateUrlsTrait(array<string|int, mixed> $data, Field|Field_Validation $field) : array<string|int, mixed>
  • マルチ項目フィールド (['value' => {...}, 'array' => [...]]) の中の path / html
  • グループ内マルチ項目（連番キーの行配列の中の各 baseName）の path / html

単一値フィールドや、グループ内単一値フィールドには URL 解決を適用しない（旧挙動）。

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

setConfigTrait()

コンフィグのセット

protected setConfigTrait() : bool
Return values
bool

setIntegerValue()

整数型の値を設定

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

resolveTemplateUrlsInGroupRowTrait()

グループ内の 1 行に含まれるマルチ項目（連想配列構造）に対して URL 解決を適用。

private resolveTemplateUrlsInGroupRowTrait(array<string|int, mixed> $row, Field|Field_Validation $field) : array<string|int, mixed>

グループ内単一値は ['value' => x] の形なのでスキップ。 グループ内マルチ項目は ['alt' => x, 'path' => y, ...] の形。

Parameters
$row : array<string|int, mixed>
$field : Field|Field_Validation
Return values
array<string|int, mixed>

resolveTemplateUrlsInMultiEntryTrait()

マルチ項目フィールドエントリ（'value'/'array' を持つ）に対して URL 解決を適用。

private resolveTemplateUrlsInMultiEntryTrait(array<string|int, mixed> $entry, string $baseName, Field|Field_Validation $field) : array<string|int, mixed>
Parameters
$entry : array<string|int, mixed>
$baseName : string
$field : Field|Field_Validation
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results