CounterCache¶

基本的な使用方法¶

他のビヘイビアーと同様に CounterCache ビヘイビアーを有効にしますが、 いくつかのリレーションとそれらのそれぞれに格納されるフィールド数を設定するまでは何も行いません。 以下の例を使用して、各記事のコメント数を次のようにキャッシュすることができます。

class CommentsTable extends Table
{
    public function initialize(array $config): void
    {
        $this->addBehavior('CounterCache', [
            'Articles' => ['comment_count']
        ]);
    }
}

CounterCache の設定は、リレーション名のマップとそのリレーションに対する具体的な設定でなければなりません。

カウンターの値は、エンティティーが保存または削除されるたびに更新されます。 updateAll() または deleteAll() を使用するか、作成した SQL を実行すると、 カウンターは更新 されません。

高度な使用方法¶

キャッシュされたカウンターを関連するすべてのレコードより少なく保つ必要がある場合は、 カウンター値を生成するために追加の条件またはファインダーメソッドを指定できます。

// 特定の find メソッドを使用する。
// find(published) の場合
$this->addBehavior('CounterCache', [
    'Articles' => [
        'comment_count' => [
            'finder' => 'published'
        ]
    ]
]);

カスタムファインダーメソッドがない場合は、代わりにレコードを検索するための条件の配列を指定できます。

$this->addBehavior('CounterCache', [
    'Articles' => [
        'comment_count' => [
            'conditions' => ['Comments.spam' => false]
        ]
    ]
]);

CounterCache で複数のフィールドを更新する場合（条件付きカウントと基本カウントの両方を表示するなど）、 これらのフィールドを配列に追加できます。

$this->addBehavior('CounterCache', [
    'Articles' => ['comment_count',
        'published_comment_count' => [
            'finder' => 'published'
        ]
    ]
]);

独自の CounterCache フィールド値を計算する場合は、 ignoreDirty オプションを true に設定します。 これにより、前に dirty を設定した場合、フィールドが再計算されなくなります。

$this->addBehavior('CounterCache', [
    'Articles' => [
        'comment_count' => [
            'ignoreDirty' => true
        ]
    ]
]);

最後に、カスタムファインダーと条件が適切でない場合は、コールバックメソッドを提供することができます。 この呼び出し可能オブジェクトは、格納するカウント値を返さなければなりません。

$this->addBehavior('CounterCache', [
    'Articles' => [
        'rating_avg' => function ($event, $entity, $table, $original) {
            return 4.5;
        }
    ]
]);

あなたの関数は、カウンター列の更新をスキップするために false を返したり、 カウント値を生成した Query オブジェクトを返すことができます。 Query オブジェクトを返すと、そのクエリーは update 文のサブクエリーとして使われます。 $table パラメーターは、便宜上、ビヘイビアーを保持している (ターゲット関係ではない) テーブルオブジェクトを参照します。コールバックは、 $original に false が設定されて 少なくとも1回呼び出されます。 entity-update がアソシエーションを変更した場合、コールバックは true で 2回 呼び出され、 戻り値は 以前 に関連付けられたアイテムのカウンターを更新します。