Changeset 114347 in spip-zone


Ignore:
Timestamp:
Mar 5, 2019, 5:21:27 AM (6 months ago)
Author:
jluc@…
Message:

phpdoc cachelab

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/cachelab/trunk/inc/cachelab.php

    r112724 r114347  
    55include_spip('public/cachelab_utils');
    66
    7 //
    8 // Applique une action sur un cache donné
    9 //
    10 // Nécessite Mémoization (toutes méthodes OK).
    11 //
    12 // Renvoie un booléen indiquant si l'action a pu être appliquée ou non
    13 //
     7/**
     8 *
     9 * Applique une action sur un cache donné et renvoie éventuellement une donnée
     10 * Nécessite Mémoization (toutes méthodes OK).
     11 *
     12 * @param $action : del, pass, list, clean, list_html, get, get_html ou user defined
     13 * @param $cle : clé du cache ciblé
     14 * @param null $data : valeur du cache pour cette clé (pas forcément fourni)
     15 * @param string $options
     16 * @param null $return : résultat éventuellement fourni, pour les actions list et get
     17 * @return bool : indique si l'action a pu être appliquée ou non
     18 */
    1419function cachelab_applique ($action, $cle, $data=null, $options='', &$return=null) {
    1520global $Memoization;
     
    7075}
    7176
    72 function cachelab_filtre($action, $conditions=array(), $options=array()) {
    73         spip_log ("cachelab_filtre obsolète avec $action, ".print_r($conditions, 1), "OBSOLETE_cachelab");
    74         return cachelab_cibler ($action, $conditions, $options);
    75 }
    76 
    77 //
    78 // cachelab_cibler :
    79 //      applique une action donnée à tous les caches vérifiant certaines conditions
    80 //
    81 // uses apcu_cache_info()
    82 //      et donc nécessite que Memoization soit activé avec APC ou APCu
    83 //
    84 // renvoie :
    85 //      le résultat si c'est une action 'get' ou 'get_...'
    86 //      la liste des stats sinon, avec éventuellement la liste des résultats s'ils sont demandés (pour 'list_html'...)
    87 //
     77/**
     78 *
     79 * Applique une action donnée à tous les caches vérifiant certaines conditions
     80 *
     81 * @uses apcu_cache_info() et donc nécessite que Memoization soit activé avec APC ou APCu
     82 *
     83 * @param $action   : l'action à appliquer
     84 * @param array $conditions : les conditions définissant la cible
     85 * @param array $options    : options de l'action et/ou des conditions
     86 * @return array|null
     87 *      le résultat si c'est une action 'get' ou 'get_...'
     88 *      la liste des stats sinon, avec éventuellement la liste des résultats s'ils sont demandés (pour 'list_html'...)
     89 *
     90 */
    8891function cachelab_cibler ($action, $conditions=array(), $options=array()) {
    8992global $Memoization;
     
    277280}
    278281
     282/**
     283 * @param $action
     284 * @param array $objets_invalidants
     285 */
    279286function controler_invalideur($action, $objets_invalidants=array()) {
    280287static $prev_derniere_modif_invalide;
     
    301308// Toutes les valeurs doivent être vérifiées dans l'environnement.
    302309//
     310/**
     311 * @param $action
     312 * @param $conditions
     313 * @param $options
     314 * @param $cle
     315 * @param $data
     316 * @param $stats
     317 * @return bool
     318 */
    303319function cachelab_ciblercache_contexte($action, $conditions, $options, $cle, &$data, &$stats) {
    304320        if (!isset ($data['contexte'])
Note: See TracChangeset for help on using the changeset viewer.