a-blog cms PHP API Reference

Config extends Facade
in package

Table of Contents

Properties

$container  : Container
$instance  : mixed

Methods

__callStatic()  : mixed
cacheClear()  : void
canViewIndex()  : bool
fix()  : Field
forgetCache()  : void
forgetConfigSetNameCache()  : void
get()  : mixed
getAncestorBlogConfigSet()  : int|null
getAncestorCategoryConfigSet()  : int|null
getArray()  : array<string|int, mixed>
getCurrentConfigSetId()  : int|null
getCurrentConfigSetName()  : string|null
getCurrentEditorSetId()  : int|null
getCurrentEditorSetName()  : string|null
getCurrentThemeSetId()  : int|null
getCurrentThemeSetName()  : string|null
getDataBaseSchemaInfo()  : array<string|int, mixed>
getInstance()  : mixed
get service instance
isExistsRuleModuleConfig()  : bool
isOperable()  : bool
load()  : Field
loadBlogConfig()  : Field
loadBlogConfigSet()  : Field
loadBlogEditorSet()  : Field
loadBlogField()  : Field
loadBlogThemeSet()  : Field
loadCategoryConfigSet()  : Field
loadCategoryEditorSet()  : Field
loadCategoryThemeSet()  : Field
loadConfigSet()  : Field
loadConfigSetField()  : Field
loadDefault()  : array<string|int, mixed>
loadDefaultField()  : Field
loadModuleConfig()  : Field
loadRuleConfig()  : Field
loadRuleConfigSet()  : Field
loadRuleEditorSet()  : Field
loadRuleThemeSet()  : Field
resetConfig()  : void
saveConfig()  : true
set()  : true
setContainer()  : void
setValide()  : Field_Validation
yamlDump()  : mixed
yamlLoad()  : mixed
yamlParse()  : mixed
getServiceAlias()  : string
getServiceInstance()  : mixed
isCache()  : bool

Properties

$instance

protected static mixed $instance

Methods

__callStatic()

public static __callStatic(string $method, array<string|int, mixed> $arguments) : mixed
Parameters
$method : string
$arguments : array<string|int, mixed>

cacheClear()

public static cacheClear() : void

コンフィグキャッシュを全て削除する

canViewIndex()

public static canViewIndex(int $blogId) : bool

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

Parameters
$blogId : int
Return values
bool

fix()

public static fix(Field $Config) : Field

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

Parameters
$Config : Field
Return values
Field

forgetCache()

public static forgetCache([int|null $bid = = 'null' ][, int|null $rid = = 'null' ][, int|null $mid = = 'null' ][, int|null $setid = = 'null' ]) : void

コンフィグキャッシュを削除する

Parameters
$bid : int|null = = 'null'
$rid : int|null = = 'null'
$mid : int|null = = 'null'
$setid : int|null = = 'null'

forgetConfigSetNameCache()

public static forgetConfigSetNameCache(mixed $setid) : void

コンフィグセット名キャッシュを削除する

Parameters
$setid : mixed

get()

public static get(string $key[, mixed $default = = 'null' ][, int $i = = '0' ]) : mixed

指定されたキーに該当するコンフィグを取得する

Parameters
$key : string
$default : mixed = = 'null'
$i : int = = '0'

getAncestorBlogConfigSet()

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

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

Parameters
$bid : int
$type : string
Return values
int|null

getAncestorCategoryConfigSet()

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

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

Parameters
$cid : int
$type : string
Return values
int|null

getArray()

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

指定されたキーに該当するコンフィグを配列で取得する

Parameters
$key : string
$strict : bool = = 'false'
Return values
array<string|int, mixed>

getCurrentConfigSetId()

public static getCurrentConfigSetId() : int|null

現在のコンフィグセットのidを取得する

Return values
int|null

getCurrentConfigSetName()

public static getCurrentConfigSetName() : string|null

現在のコンフィグセットの名前を取得する

Return values
string|null

getCurrentEditorSetId()

public static getCurrentEditorSetId() : int|null

現在の編集画面セットのidを取得する

Return values
int|null

getCurrentEditorSetName()

public static getCurrentEditorSetName() : string|null

現在の編集画面セットの名前を取得する

Return values
string|null

getCurrentThemeSetId()

public static getCurrentThemeSetId() : int|null

現在のテーマセットのidを取得する

Return values
int|null

getCurrentThemeSetName()

public static getCurrentThemeSetName() : string|null

現在のテーマセットの名前を取得する

Return values
string|null

getDataBaseSchemaInfo()

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

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

Parameters
$type : string
Return values
array<string|int, mixed>

getInstance()

get service instance

public static getInstance() : mixed

isExistsRuleModuleConfig()

public static isExistsRuleModuleConfig() : bool

ルールモジュールのコンフィグが存在するか確認する

Return values
bool

isOperable()

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

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

Parameters
$rid : int|null = = 'null'
$mid : int|null = = 'null'
$setid : int|null = = 'null'
Return values
bool

load()

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

コンフィグを取得する

Parameters
$bid : int|null = = 'null'
$rid : int|null = = 'null'
$mid : int|null = = 'null'
$setid : int|null = = 'null'
Return values
Field

loadBlogConfig()

public static loadBlogConfig(int $bid) : Field

ブログのコンフィグをFieldで返す

Parameters
$bid : int
Return values
Field

loadBlogConfigSet()

public static loadBlogConfigSet(int $bid) : Field

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

Parameters
$bid : int
Return values
Field

loadBlogEditorSet()

public static loadBlogEditorSet(int $bid) : Field

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

Parameters
$bid : int
Return values
Field

loadBlogField()

public static loadBlogField(int $bid) : Field

ブログのコンフィグをFieldで返す

Parameters
$bid : int
Return values
Field

loadBlogThemeSet()

public static loadBlogThemeSet(int $bid) : Field

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

Parameters
$bid : int
Return values
Field

loadCategoryConfigSet()

public static loadCategoryConfigSet(int $cid) : Field

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

Parameters
$cid : int
Return values
Field

loadCategoryEditorSet()

public static loadCategoryEditorSet(int $cid) : Field

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

Parameters
$cid : int
Return values
Field

loadCategoryThemeSet()

public static loadCategoryThemeSet(int $cid) : Field

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

Parameters
$cid : int
Return values
Field

loadConfigSet()

public static loadConfigSet(int $id) : Field

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

Parameters
$id : int
Return values
Field

loadConfigSetField()

public static loadConfigSetField(int $id) : Field

コンフィグセットのコンフィグをFieldで返す

Parameters
$id : int
Return values
Field

loadDefault()

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

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

Return values
array<string|int, mixed>

loadDefaultField()

public static loadDefaultField() : Field

config.system.yamlに記録されているデフォルトのコンフィグをFieldで返す

Return values
Field

loadModuleConfig()

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

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

Parameters
$mid : int
$rid : int|null = = 'null'
Return values
Field

loadRuleConfig()

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

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

Parameters
$rid : int
$setid : int|null = = 'null'
Return values
Field

loadRuleConfigSet()

public static loadRuleConfigSet(int $rid) : Field

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

Parameters
$rid : int
Return values
Field

loadRuleEditorSet()

public static loadRuleEditorSet(int $rid) : Field

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

Parameters
$rid : int
Return values
Field

loadRuleThemeSet()

public static loadRuleThemeSet(int $rid) : Field

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

Parameters
$rid : int
Return values
Field

resetConfig()

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

コンフィグをリセットする

Parameters
$Config : Field
$bid : int = = 'null'
$rid : int|null = = 'null'
$mid : int|null = = 'null'
$setid : int|null = = 'null'

saveConfig()

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

コンフィグを保存する

Parameters
$Config : Field
$bid : int|null = = 'null'
$rid : int|null = = 'null'
$mid : int|null = = 'null'
$setid : int|null = = 'null'
Return values
true

set()

public static set(string $key[, mixed $val = = 'null' ]) : true

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

Parameters
$key : string
$val : mixed = = 'null'
Return values
true

yamlDump()

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

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

Parameters
$data : mixed
$path : string = = '\'\''

yamlLoad()

public static yamlLoad(string $path) : mixed

yamlファイルの取得

Parameters
$path : string

yamlParse()

public static yamlParse(string $yaml) : mixed

yamlファイルのパース

Parameters
$yaml : string

getServiceAlias()

protected static getServiceAlias() : string
Return values
string

getServiceInstance()

protected static getServiceInstance(string $alias) : mixed
Parameters
$alias : string

isCache()

protected static isCache() : bool
Return values
bool

        
On this page

Search results