Extensions : création de nouveaux ciblages et actions sur le cache

Définir une nouvelle méthode de filtrage

C’est l’index plus de la condition passée à cachelab_cibler qui spécifie la fonction à utiliser pour filtrer.

Lorsque $conditions['plus'] vaut monfiltrage, le webmestre doit définir une fonction cachelab_ciblercache_monfiltrage($action, $conditions, $options, $cle, &$data, &$stats) qui renvoie true ou false selon que le cache vérifie ou non le filtrage désiré.

Les arguments en sont :

-  $action, $conditions, $options : les paramètres reçus par cachelab_cibler.

-  $cle : la clé du cache APC à tester
-  $data : la valeur du cache APC à tester, y compris les métadonnées. Cet argument est passé par référence (pour efficacité et pour permettre de modifier le cache ou les métadonnées).
-  $stats : le tableau de stats en cours. Cet argument est passé par référence et peut être modifié par la nouvelle fonction de filtrage, pour incrémenter les statistiques, augmenter les listes de caches et éventuellement pour renvoyer des résultats complémentaires.

Ce filtrage dédié est appelée après les filtrages par session, chemin et cle_objet s’ils sont spécifiés.

Le filtrage par contexte, proposé d’origine dans CacheLab est un exemple d’extension. En effet, cette méthode de filtrage est implémentée au moyen d’une fonction cachelab_ciblercache_contexte et cela peut vous aider à créer la vôtre. Mais de ce fait, il n’est pas possible de combiner contexte avec un plus pour faire un test plus complexe en une seule passe. Pour faire cela, il faudrait définir un nouveau “plus” qui combine le test du ’contexte’ et la contrainte spécifique ajoutée, et l’appeler directement (sans en plus filtrer par contexte).

Définir ses propres actions

Pour définir une nouvelle action nouvelleaction, il faudra définir une fonction cachelab_appliquer_nouvelleaction($action, $cle, $data=null, $options='', &$return=null) sur le modèle de la fonction cachelab_appliquer livrée dans le plugin.
Cette fonction sera appelée tour à tour par cachelab_cibler pour chacun des caches ciblés.
-  Elle devra appliquer l’action nouvelleaction sur le cache dont la clé est reçue en paramètre $cle et dont le contenu est $data s’il est déjà connu (dans le cas où le filtre ne porte pas seulement sur le chemin mais aussi sur le contexte).
-  Les options de ciblage sont $options.
-  Elle renverra true si elle a pu appliquer l’action et false sinon.
-  La fonction pourra éventuellement ajouter un résultat au tableau $return passé en référence. Ce tableau pourra être récupéré dans le champ ’return’ de la valeur de retour de cachelab_cibler.