API Documentation
\

\SiteSettingUtil

SiteSetting Utility

サイトの設定として必要な情報を保持します。
NetCommonsAppController::beforeFilter で初期処理が呼び出され、値が設定されます。
値を取得する時は、readメソッドを使用します。
値を保持する時は、writeメソッドを使用します。
値を削除する時は、removeメソッドを使用します。

Summary

Methods
Properties
Constants
initialize()
setup()
read()
write()
remove()
reset()
readAll()
No public properties found
No constants found
_tokenize()
$_data
$_initialized
$_SiteSetting
$_SiteSettingUtilFunc
N/A
__prepareUtility()
No private properties found
N/A

Properties

$_data

$_data : array

サイト設定のデータ保持用

Type

array

$_initialized

$_initialized : array

initializeしたかどうか

Type

array

$_SiteSetting

$_SiteSetting : \SiteSetting

SiteSettingモデル

Type

\SiteSetting

$_SiteSettingUtilFunc

$_SiteSettingUtilFunc : \SiteSettingUtilFunc

SiteSettingUtilFuncユーティリティ

Type

\SiteSettingUtilFunc

Methods

setup()

setup(array  $keyPaths, boolean  $force = false) : void

データをセットする

Parameters

array $keyPaths

Hashクラスのpath
boolean $force

強制的に書き込むかどうか。falseの場合、既にあれば書き込みを行わない。

read()

read(string|null  $keyPath, mixed  $default = null, integer  $langId = null) : array|null

指定された$keyの値を返します。

サイト名(App.site_name)を取得したい場合

SiteSetting::read('App.site_name');

Parameters

string|null $keyPath

Hashクラスのpath
mixed $default

デフォルト値
integer $langId

言語ID(Language.id)

Returns

array|null —

SiteSettingデータ

write()

write(string  $keyPath, mixed  $value, integer  $langId) : void

指定された$keyの値をセットします

サイト名(App.site_name)をセットしたい場合

SiteSetting::write('App.site_name', 'NetCommons3', '2');

Parameters

string $keyPath

Hashクラスのpath、nullの場合、Hash::mergeする
mixed $value

セットする値
integer $langId

言語ID(Language.id)

remove()

remove(string  $keyPath, integer|null  $langId = null) : void

指定された$keyの値を削除します。

サイト名(App.site_name)を削除したい場合

SiteSetting::remove('App.site_name')

Parameters

string $keyPath

Hashクラスのpath
integer|null $langId

言語ID(Language.id)

reset()

reset() : void

全てのデータをクリアする

readAll()

readAll() : array

全てのデータを取得

Returns

array

_tokenize()

_tokenize(string  $keyPath) : array

CakeText::tokenizeをSiteSetting用に修正

Parameters

string $keyPath

Hashクラスのpath

Returns

array

__prepareUtility()

__prepareUtility() : void

Utilityの事前準備

staticにしているため、constractが使用されないので、各メソッドで呼び出す