CounterCache¶

Usage Basique¶

Vous activez le behavior CounterCache comme tous les autres behaviors, mais il ne fera rien jusqu’à ce que vous configuriez quelques relations et le nombre de champs qui doivent être stockés sur chacun d’eux. Utiliser notre exemple ci-dessous, nous pourrions mettre en cache le nombre de commentaires pour chaque article avec ce qui suit:

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

La configuration de CounterCache doit être composée de noms de relations et de la configuration spécifique pour cette relation.

Comme vous le voyez, il faut ajouter le behavior « de l’autre côté » de l’association dans laquelle vous voulez que le champ soit mis à jour. Dans cet exemple, le behavior est ajouté dans la table CommentsTable bien qu’il actualise le champ comment_count dans la table ArticlesTable.

La valeur du compteur sera mise à jour à chaque fois qu’une entity est sauvegardée ou supprimée. Le compteur ne va pas être mis à jour lorsque vous

• sauvegardez une entity sans changer ses données,

• ou utilisez updateAll(),

• ou utilisez deleteAll(),

• ou exécutez du SQL que vous avez écrit vous-même.

Usage Avancé¶

Si vous avez besoin de garder un compteur mis en cache pour moins que tous les enregistrements liés, vous pouvez fournir des conditions supplémentaires ou des méthodes finder pour générer une valeur du compteur:

// Utilise une méthode find spécifique.
// Dans ce cas find(published)
$this->addBehavior('CounterCache', [
    'Articles' => [
        'comment_count' => [
            'finder' => 'published'
        ]
    ]
]);

Si vous n’avez pas de méthode de finder personnalisé, vous pouvez fournir un tableau de conditions pour trouver les enregistrements à la place:

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

Si vous voulez que CounterCache mette à jour plusieurs champs, par exemple deux champs qui montrent un compte conditionnel et un compte basique, vous pouvez ajouter ces champs dans le tableau:

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

Si vous souhaitez calculer la valeur du champ de CounterCache par vous-même, vous pouvez définir l’option ignoreDirty à true. Cela empêchera le champ d’être recalculé automatiquement si vous l’avez définit dirty avant:

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

Enfin, si un finder personnalisé et les conditions ne sont pas réunies, vous pouvez fournir une méthode de callback. Cette méthode retourne la valeur du compteur à stocker:

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

Utilisation avec Belongs To Many¶

Il est possible d’utiliser le behavior CounterCache dans une association belongsToMany. Avant tout, vous devez ajouter les options through et cascadeCallbacks à l’association belongsToMany:

'through'          => 'CommentsArticles',
'cascadeCallbacks' => true

Consultez également Utiliser l’Option “through” pour savoir comment configurer une jointure de table personnalisée. CommentsArticles est le nom de la classe de la table de jointure. Si vous ne l’avez pas, vous pouvez la créer avec l’outil bake en ligne de commande.

Dans ce src/Model/Table/CommentsArticlesTable.php, ajoutez ensuite le behavior avec le code décrit plus haut.:

$this->addBehavior('CounterCache', [
    'Articles' => [ 'comments_count' ],
]);

Pour finir, supprimez tous les caches avec bin/cake cache clear_all et faites l’essai.