a-blog cms PHP API Reference

Helper
in package

Application

Properties

$cache : Tag
$config : Field
$currentConfigSetId : int|null: 現在のコンテキストでのコンフィグセットID
$currentEditorSetId : int|null: 現在のコンテキストでの編集画面セットID
$currentThemeSetId : int|null: 現在のコンテキストでのテーマセットID

Methods

__construct() : mixed: Construct
cacheClear() : mixed: キャッシュの全クリア
canViewIndex() : bool: コンフィグ一覧を表示する権限があるかどうか
fix() : Field: コンフィグ保存の為のデータ修正
forgetCache() : mixed: キャッシュクリア
forgetConfigSetNameCache() : void: コンフィグセット名のキャッシュクリア
get() : T is string ? string : false): 現在のコンテキストにおける，指定されたキーのコンフィグを返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す
getAncestorBlogConfigSet() : int|null: 先祖ブログのグローバル設定のコンフィグセットを取得する
getAncestorCategoryConfigSet() : int|null: 先祖カテゴリーのグローバル設定のコンフィグセットを取得する
getArray() : array<string|int, mixed>: 現在のコンテキストにおける，指定されたキーのコンフィグを配列で返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す
getCurrentConfigSetId() : mixed: 現在のコンテキストでのコンフィグセットIDを返します
getCurrentConfigSetName() : mixed: 現在のコンテキストでのコンフィグセット名を返します
getCurrentEditorSetId() : mixed: 現在のコンテキストでの編集画面セットIDを返します
getCurrentEditorSetName() : mixed: 現在のコンテキストでの編集画面セット名を返します
getCurrentThemeSetId() : mixed: 現在のコンテキストでのテーマセットIDを返します
getCurrentThemeSetName() : mixed: 現在のコンテキストでのテーマセット名を返します
getDataBaseSchemaInfo() : array<string|int, mixed>|mixed: タイプ指定によるデータベーススキーマの取得
isExistsRuleModuleConfig() : bool: ルールのモジュールコンフィグが存在するかチェック
isOperable() : bool: コンフィグの操作権限があるかどうか
load() : Field: ブログID, ルールID, モジュールIDによって指定されたコンテキストのコンフィグをFieldで返す
loadBlogConfig() : Field: 指定されたidに該当するブログのコンフィグをFieldで返す
loadBlogConfigSet() : mixed: 指定されたidに該当するブログのコンフィグセットを考慮したFieldを返す
loadBlogEditorSet() : mixed: 指定されたidに該当するブログの編集画面セットを考慮したFieldを返す
loadBlogField() : mixed: 指定されたidに該当するブログのコンフィグをキャッシュされたFieldで返す
loadBlogThemeSet() : mixed: 指定されたidに該当するブログのテーマセットを考慮したFieldを返す
loadCategoryConfigSet() : mixed: 指定されたidに該当するカテゴリーのコンフィグセットを考慮したFieldを返す
loadCategoryEditorSet() : mixed: 指定されたidに該当するカテゴリーの編集画面セットを考慮したFieldを返す
loadCategoryThemeSet() : mixed: 指定されたidに該当するカテゴリーのテーマセットを考慮したFieldを返す
loadConfigSet() : Field: 指定されたidに該当するコンフィグセットのコンフィグをFieldで返す
loadConfigSetField() : mixed: 指定されたidに該当するコンフィグセットのコンフィグをキャッシュされたFieldで返す
loadDefault() : array<string|int, mixed>: config.sytem.yamlに記録されているデフォルトのコンフィグを連想配列で返す
loadDefaultField() : Field: config.system.yamlに記載されているデフォルトのコンフィグをキャッシュされたFieldで返す
loadModuleConfig() : Field: 指定されたidに該当するモジュールIDのコンフィグをFieldで返す
loadRuleConfig() : Field: 指定されたidに該当するルールのコンフィグをFieldで返す
loadRuleConfigSet() : Field|false: 指定されたルールidに該当するルールのコンフィグセットを考慮したFieldを返す
loadRuleEditorSet() : Field|false: 指定されたルールidに該当するルールの編集画面セットを考慮したFieldを返す
loadRuleThemeSet() : Field|false: 指定されたルールidに該当するルールのテーマセットを考慮したFieldを返す
resetConfig() : void: コンフィグのリセット
saveConfig() : true: コンフィグの保存
set() : bool: 現在のコンテキストにおける，指定されたキーのコンフィグを一時的に書き換える
setValide() : Field_Validation: コンフィグへのアクセス権限チェック
yamlDump() : string: データをyamlに変換してファイルに書き出し
yamlLoad() : mixed: yamlファイルのパース
yamlParse() : mixed: yamlデータのパース
fixSize() : mixed
getCacheTags() : mixed: キャッシュのためのタグを取得
isValidConfig() : bool: コンフィグが正しいデータ構造かどうかをチェック
needToLoadDefaultConfig() : bool: デフォルトのコンフィグをYAMLからロードする必要があるか判定

$cache


        protected
            Tag
    $cache

$config


        protected
            Field
    $config

$currentConfigSetId

現在のコンテキストでのコンフィグセットID


        private
            int|null
    $currentConfigSetId
     = null

$currentEditorSetId

現在のコンテキストでの編集画面セットID


        private
            int|null
    $currentEditorSetId
     = null

$currentThemeSetId

現在のコンテキストでのテーマセットID


        private
            int|null
    $currentThemeSetId
     = null

__construct()

Construct


    public
                    __construct() : mixed

cacheClear()

キャッシュの全クリア


    public
                    cacheClear() : mixed

canViewIndex()

コンフィグ一覧を表示する権限があるかどうか


    public
                    canViewIndex(int $blogId) : bool

Parameters

$blogId : int

Return values

bool

fix()

コンフィグ保存の為のデータ修正


    public
                    fix(Field $Config) : Field

Parameters

$Config : Field

Return values

Field

forgetCache()

キャッシュクリア


    public
                    forgetCache([int $bid = null ][, int $rid = null ][, int $mid = null ][, int $setid = null ]) : mixed

Parameters

$bid : int = null
$rid : int = null
$mid : int = null
$setid : int = null

forgetConfigSetNameCache()

コンフィグセット名のキャッシュクリア


    public
                    forgetConfigSetNameCache(mixed $setid) : void

Parameters

$setid : mixed

get()

現在のコンテキストにおける，指定されたキーのコンフィグを返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す


    public
                    get(T $key[, string|int|null $default = null ][, int $i = 0 ]) : T is string ? string : false)

Parameters

$key : T
$default : string|int|null = null
$i : int = 0

Return values

T is string ? string : false)

getAncestorBlogConfigSet()

先祖ブログのグローバル設定のコンフィグセットを取得する


    public
                    getAncestorBlogConfigSet(int $bid, mixed $type) : int|null

Parameters

$bid : int
$type : mixed

Return values

int|null

getAncestorCategoryConfigSet()

先祖カテゴリーのグローバル設定のコンフィグセットを取得する


    public
                    getAncestorCategoryConfigSet(int $cid, mixed $type) : int|null

Parameters

$cid : int
$type : mixed

Return values

int|null

getArray()

現在のコンテキストにおける，指定されたキーのコンフィグを配列で返すモジュール内で使用した場合は，モジュールIDで設定されたコンフィグを返す


    public
                    getArray(string $key[, bool $strict = false ]) : array<string|int, mixed>

Parameters

$key : string
$strict : bool = false

Return values

array<string|int, mixed>

getCurrentConfigSetId()

現在のコンテキストでのコンフィグセットIDを返します


    public
                    getCurrentConfigSetId() : mixed

getCurrentConfigSetName()

現在のコンテキストでのコンフィグセット名を返します


    public
                    getCurrentConfigSetName() : mixed

getCurrentEditorSetId()

現在のコンテキストでの編集画面セットIDを返します


    public
                    getCurrentEditorSetId() : mixed

getCurrentEditorSetName()

現在のコンテキストでの編集画面セット名を返します


    public
                    getCurrentEditorSetName() : mixed

getCurrentThemeSetId()

現在のコンテキストでのテーマセットIDを返します


    public
                    getCurrentThemeSetId() : mixed

getCurrentThemeSetName()

現在のコンテキストでのテーマセット名を返します


    public
                    getCurrentThemeSetName() : mixed

getDataBaseSchemaInfo()

タイプ指定によるデータベーススキーマの取得


    public
                    getDataBaseSchemaInfo(string $type) : array<string|int, mixed>|mixed

Parameters

$type : string

Return values

array<string|int, mixed>|mixed

isExistsRuleModuleConfig()

ルールのモジュールコンフィグが存在するかチェック


    public
                    isExistsRuleModuleConfig() : bool

Return values

bool

isOperable()

コンフィグの操作権限があるかどうか


    public
                    isOperable([int $rid = null ][, int $mid = null ][, int $setid = null ]) : bool

Parameters

$rid : int = null
$mid : int = null
$setid : int = null

Return values

bool

load()

ブログID, ルールID, モジュールIDによって指定されたコンテキストのコンフィグをFieldで返す


    public
                    load([int $bid = null ][, int $rid = null ][, int $mid = null ][, int $setid = null ]) : Field

Parameters

$bid : int = null
$rid : int = null
$mid : int = null
$setid : int = null

Return values

Field

loadBlogConfig()

指定されたidに該当するブログのコンフィグをFieldで返す


    public
                    loadBlogConfig(int $bid) : Field

Parameters

$bid : int

Return values

Field

loadBlogConfigSet()

指定されたidに該当するブログのコンフィグセットを考慮したFieldを返す


    public
                    loadBlogConfigSet(mixed $bid) : mixed

Parameters

$bid : mixed

loadBlogEditorSet()

指定されたidに該当するブログの編集画面セットを考慮したFieldを返す


    public
                    loadBlogEditorSet(mixed $bid) : mixed

Parameters

$bid : mixed

loadBlogField()

指定されたidに該当するブログのコンフィグをキャッシュされたFieldで返す


    public
                    loadBlogField(mixed $bid) : mixed

Parameters

$bid : mixed

loadBlogThemeSet()

指定されたidに該当するブログのテーマセットを考慮したFieldを返す


    public
                    loadBlogThemeSet(mixed $bid) : mixed

Parameters

$bid : mixed

loadCategoryConfigSet()

指定されたidに該当するカテゴリーのコンフィグセットを考慮したFieldを返す


    public
                    loadCategoryConfigSet(mixed $cid) : mixed

Parameters

$cid : mixed

loadCategoryEditorSet()

指定されたidに該当するカテゴリーの編集画面セットを考慮したFieldを返す


    public
                    loadCategoryEditorSet(mixed $cid) : mixed

Parameters

$cid : mixed

loadCategoryThemeSet()

指定されたidに該当するカテゴリーのテーマセットを考慮したFieldを返す


    public
                    loadCategoryThemeSet(mixed $cid) : mixed

Parameters

$cid : mixed

loadConfigSet()

指定されたidに該当するコンフィグセットのコンフィグをFieldで返す


    public
                    loadConfigSet(int $id) : Field

Parameters

$id : int

Return values

Field

loadConfigSetField()

指定されたidに該当するコンフィグセットのコンフィグをキャッシュされたFieldで返す


    public
                    loadConfigSetField(mixed $id) : mixed

Parameters

$id : mixed

loadDefault()

config.sytem.yamlに記録されているデフォルトのコンフィグを連想配列で返す


    public
                    loadDefault() : array<string|int, mixed>

Return values

array<string|int, mixed>

loadDefaultField()

config.system.yamlに記載されているデフォルトのコンフィグをキャッシュされたFieldで返す


    public
                    loadDefaultField() : Field

Return values

Field

loadModuleConfig()

指定されたidに該当するモジュールIDのコンフィグをFieldで返す


    public
                    loadModuleConfig(int $mid[, int $rid = null ]) : Field

Parameters

$mid : int
$rid : int = null

Return values

Field

loadRuleConfig()

指定されたidに該当するルールのコンフィグをFieldで返す


    public
                    loadRuleConfig(int $rid[, int $setid = null ]) : Field

Parameters

$rid : int
$setid : int = null

Return values

Field

loadRuleConfigSet()

指定されたルールidに該当するルールのコンフィグセットを考慮したFieldを返す


    public
                    loadRuleConfigSet(int $rid) : Field|false

Parameters

$rid : int

Return values

Field|false

loadRuleEditorSet()

指定されたルールidに該当するルールの編集画面セットを考慮したFieldを返す


    public
                    loadRuleEditorSet(int $rid) : Field|false

Parameters

$rid : int

Return values

Field|false

loadRuleThemeSet()

指定されたルールidに該当するルールのテーマセットを考慮したFieldを返す


    public
                    loadRuleThemeSet(int $rid) : Field|false

Parameters

$rid : int

Return values

Field|false

resetConfig()

コンフィグのリセット


    public
                    resetConfig(Field $Config[, int $bid = BID ][, int $rid = null ][, int $mid = null ][, int $setid = null ]) : void

Parameters

$Config : Field
$bid : int = BID
$rid : int = null
$mid : int = null
$setid : int = null

saveConfig()

コンフィグの保存


    public
                    saveConfig(Field $Config[, int $bid = BID ][, int $rid = null ][, int $mid = null ][, int $setid = null ]) : true

Parameters

$Config : Field
$bid : int = BID
$rid : int = null
$mid : int = null
$setid : int = null

Return values

true

set()

現在のコンテキストにおける，指定されたキーのコンフィグを一時的に書き換える


    public
                    set(string $key[, mixed $val = null ]) : bool

Parameters

$key : string
$val : mixed = null

Return values

bool

setValide()

コンフィグへのアクセス権限チェック


    public
                    setValide(Field_Validation $Config[, int $rid = null ][, int $mid = null ][, int $setid = null ]) : Field_Validation

Parameters

$Config : Field_Validation
$rid : int = null
$mid : int = null
$setid : int = null

Return values

Field_Validation

yamlDump()

データをyamlに変換してファイルに書き出し


    public
                    yamlDump(mixed $data[, string $path = '' ]) : string

Parameters

$data : mixed
$path : string = ''

Return values

string

yamlLoad()

yamlファイルのパース


    public
                    yamlLoad(string $path) : mixed

Parameters

$path : string

yamlParse()

yamlデータのパース


    public
                    yamlParse(string $yaml) : mixed

Parameters

$yaml : string

fixSize()


    protected
                    fixSize(mixed &$Config, mixed $key) : mixed

Parameters

$Config : mixed
$key : mixed

getCacheTags()

キャッシュのためのタグを取得


    protected
                    getCacheTags(int $bid, int $rid, int $mid, int $setid) : mixed

Parameters

$bid : int
$rid : int
$mid : int
$setid : int

isValidConfig()

コンフィグが正しいデータ構造かどうかをチェック


    protected
                    isValidConfig(mixed $data) : bool

Parameters

$data : mixed

Return values

bool

needToLoadDefaultConfig()

デフォルトのコンフィグをYAMLからロードする必要があるか判定


    protected
                    needToLoadDefaultConfig() : bool

Return values

bool

Helper in package Application

Table of Contents

Properties

Methods

Properties

$cache

$config

$currentConfigSetId

$currentEditorSetId

$currentThemeSetId

Methods

__construct()

cacheClear()

canViewIndex()

Parameters

Return values

fix()

Parameters

Return values

forgetCache()

Parameters

forgetConfigSetNameCache()

Parameters

get()

Parameters

Tags

Return values

getAncestorBlogConfigSet()

Parameters

Return values

getAncestorCategoryConfigSet()

Parameters

Return values

getArray()

Parameters

Return values

getCurrentConfigSetId()

getCurrentConfigSetName()

getCurrentEditorSetId()

getCurrentEditorSetName()

getCurrentThemeSetId()

getCurrentThemeSetName()

getDataBaseSchemaInfo()

Parameters

Return values

isExistsRuleModuleConfig()

Return values

isOperable()

Parameters

Return values

load()

Parameters

Return values

loadBlogConfig()

Parameters

Return values

loadBlogConfigSet()

Parameters

loadBlogEditorSet()

Parameters

loadBlogField()

Parameters

loadBlogThemeSet()

Parameters

loadCategoryConfigSet()

Parameters

loadCategoryEditorSet()

Parameters

loadCategoryThemeSet()

Parameters

loadConfigSet()

Parameters

Return values

loadConfigSetField()

Parameters

loadDefault()

Return values

loadDefaultField()

Return values

loadModuleConfig()

Helper
in package

Application