a-blog cms PHP API Reference

GetModule
in package

Table of Contents

Properties

$cache  : array<string|int, mixed>
キャッシュ

Methods

moduleFunction()  : array<string|int, mixed>
twigテンプレートから「module」関数で呼び出し
buildUrlContext()  : string
URLコンテキストをパスに組み立て
generateCacheKey()  : string
キャッシュキーを生成
getContextByModule()  : array<string|int, mixed>
モジュールIDのコンテキスト設定を取得
getModuleId()  : null|array<string|int, mixed>
モジュールIDを取得
getScopes()  : array<string|int, mixed>
モジュールのスコープを取得
validate()  : bool
アクセスできない情報を参照しようとしているのであれば403を返す

Properties

$cache

キャッシュ

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

Methods

moduleFunction()

twigテンプレートから「module」関数で呼び出し

public moduleFunction(string $name[, string $identifier = null ][, 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} $ctx = [] ]) : array<string|int, mixed>
Parameters
$name : string
$identifier : string = null

|null

$ctx : 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} = []
Tags
throws
RuntimeException
throws
Exception
Return values
array<string|int, mixed>

buildUrlContext()

URLコンテキストをパスに組み立て

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

generateCacheKey()

キャッシュキーを生成

protected generateCacheKey(string $name[, string|null $identifier = null ][, array<string|int, mixed> $ctx = [] ]) : string
Parameters
$name : string
$identifier : string|null = null
$ctx : array<string|int, mixed> = []
Return values
string

getContextByModule()

モジュールIDのコンテキスト設定を取得

protected getContextByModule(array<string|int, mixed> $module) : array<string|int, mixed>
Parameters
$module : array<string|int, mixed>
Tags
throws
Exception
Return values
array<string|int, mixed>

getModuleId()

モジュールIDを取得

protected getModuleId(string $name, string|null $identifier, int $bid) : null|array<string|int, mixed>
Parameters
$name : string
$identifier : string|null
$bid : int
Return values
null|array<string|int, mixed>

getScopes()

モジュールのスコープを取得

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

validate()

アクセスできない情報を参照しようとしているのであれば403を返す

protected validate(array<string|int, mixed> $module) : bool
Parameters
$module : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
bool

        
On this page

Search results