API Documentation
\

\NetCommonsCacheBehavior

NetCommons用キャッシュ Utility

Summary

Methods
Properties
Constants
setup()
afterSave()
afterDelete()
cacheRead()
cacheWrite()
createCacheQueryKey()
cacheFindQuery()
cacheExistsQuery()
cacheClear()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$__cache
N/A

Properties

$__cache

$__cache : array

キャッシュのデータ保持用

Type

array

Methods

setup()

setup(\Model  $model, array  $config = array()) : void

ビヘイビアの設定処理

Parameters

\Model $model

ビヘイビア呼び出し元モデル
array $config

$modelの設定値

afterSave()

afterSave(\Model  $model, boolean  $created, array  $options = array()) : boolean

afterSave is called after a model is saved.

Parameters

\Model $model

Model using this behavior
boolean $created

True if this save created a new record
array $options

Options passed from Model::save().

Throws

\InternalErrorException

Returns

boolean

afterDelete()

afterDelete(\Model  $model) : void

After delete is called after any delete occurs on the attached model.

Parameters

\Model $model

Model using this behavior

cacheRead()

cacheRead(\Model  $model, string  $mainKey, string|null  $subKey = null) : array

キャッシュ変数からの読み込み

Parameters

\Model $model

ビヘイビア呼び出し元モデル
string $mainKey

メインキー
string|null $subKey

サブキー

Returns

array

cacheWrite()

cacheWrite(\Model  $model, array  $result, string  $mainKey, string|null  $subKey = null) : void

キャッシュの書き込み

Parameters

\Model $model

ビヘイビア呼び出し元モデル
array $result

結果
string $mainKey

メインキー
string|null $subKey

サブキー

createCacheQueryKey()

createCacheQueryKey(\Model  $model, array  $queryOptions) : string

find()でキャッシュする際にクエリオプションをもとにキャッシュキー生成する

Parameters

\Model $model

ビヘイビア呼び出し元モデル
array $queryOptions

find()のクエリオプション

Returns

string

cacheFindQuery()

cacheFindQuery(\Model  $model, string  $type, array  $queryOptions) : array|false

キャッシュからの読み込み もし、キャッシュに無ければ、findで取得し、キャッシュに登録する。

Parameters

\Model $model

ビヘイビア呼び出し元モデル
string $type

find()の取得種別
array $queryOptions

find()のクエリオプション

Returns

array|false

cacheExistsQuery()

cacheExistsQuery(\Model  $model, string  $id) : boolean

$model->exists()に対して、キャッシュからの読み込み もし、キャッシュに無ければ、exists()で取得し、キャッシュに登録する。

Parameters

\Model $model

ビヘイビア呼び出し元モデル
string $id

数値型の文字列

Returns

boolean

cacheClear()

cacheClear(\Model  $model) : void

キャッシュのクリア

Parameters

\Model $model

ビヘイビア呼び出し元モデル