Changeset 122298 in spip-zone


Ignore:
Timestamp:
Feb 8, 2020, 6:37:48 PM (12 days ago)
Author:
Eric Lupinacci
Message:

On change le préfixe du plugin de cache en ezcache qui est moins générique et ne posera donc plus de souci de collision.
C'est une grosse modification qui va nécessiter la mise à jour des plugins ezcheck, ezrest, rainette, n-core, taxonomie et spiperipsum

Location:
_plugins_/cache/trunk
Files:
5 added
2 deleted
7 edited
1 copied
2 moved

Legend:

Unmodified
Added
Removed
  • _plugins_/cache/trunk

    • Property subgit:lock:0e8d73aba0603f80a1a6d13ccaa5754be3d5cab8 deleted
    • Property subgit:lock:eea85f452d3d8354c44b4750a0065515b70f227e set to 2020-02-08T19:38:04.462
  • _plugins_/cache/trunk/cache_pipelines.php

    r114408 r122298  
    88        return;
    99}
    10 
    1110
    1211/**
     
    2019 * @uses configuration_cache_lire()
    2120 * @uses configuration_cache_effacer()
    22  * @uses cache_cache_configurer()
     21 * @uses ezcache_cache_configurer()
    2322 *
    24  * @param $flux
    25  *        Tableau des données permettant de caractériser la page concernée et de déclencher le traitement uniquement
    26  *        sur la page `admin_plugin`.
     23 * @param array $flux Tableau des données permettant de caractériser la page concernée et de déclencher le traitement uniquement
     24 *                    sur la page `admin_plugin`.
    2725 *
    28  * @return mixed
    29  *         Le flux entrant n'est pas modifié.
     26 * @return array Le flux entrant n'est pas modifié.
    3027 */
    31 function cache_affiche_milieu($flux) {
    32 
     28function ezcache_affiche_milieu($flux) {
    3329        if (isset($flux['args']['exec'])) {
    3430                // Initialisation de la page du privé
     
    4238                        // Recharge la configuration des plugins utilisateur :
    4339                        // -- on lit la meta pour obtenir la liste des plugins
    44                         include_spip('inc/cache');
     40                        include_spip('inc/ezcache_cache');
    4541                        $configuration = configuration_cache_lire();
    4642                        if ($configuration) {
     
    4945                                configuration_cache_effacer();
    5046                                // -- on reconfigure chaque plugin
    51                                 include_spip('cache/cache');
     47                                include_spip('ezcache/ezcache');
    5248                                foreach ($plugins as $_plugin) {
    5349                                        if (defined('_DIR_PLUGIN_' . strtoupper($_plugin))) {
    54                                                 cache_cache_configurer($_plugin);
     50                                                ezcache_cache_configurer($_plugin);
    5551                                        }
    5652                                }
  • _plugins_/cache/trunk/ezcache/ezcache.php

    r122297 r122298  
    2626 * @uses ecrire_config()
    2727 *
    28  * @param string $plugin
    29  *                       Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     28 * @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    3029 *                       un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    3130 *
    32  * @return array
    33  *               Tableau de la configuration complétée des caches d'un plugin venant d'être enregistrée.
    34  */
    35 function cache_cache_configurer($plugin) {
     31 * @return array Tableau de la configuration complétée des caches d'un plugin venant d'être enregistrée.
     32 */
     33function ezcache_cache_configurer($plugin) {
    3634
    3735        // Initialisation du tableau de configuration avec les valeurs par défaut du plugin Cache.
     
    125123 * @uses cache_service_chercher()
    126124 *
    127  * @param string $plugin
    128  *                              Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    129  *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    130  * @param array  $cache
    131  *                              Tableau identifiant le cache pour lequel on veut construire le nom.
    132  * @param array  $configuration
    133  *                              Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
     125 * @param string $plugin        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     126 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     127 * @param array  $cache         Tableau identifiant le cache pour lequel on veut construire le nom.
     128 * @param array  $configuration Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
    134129 *
    135130 * @return string
    136131 */
    137 function cache_cache_composer($plugin, $cache, $configuration) {
     132function ezcache_cache_composer($plugin, $cache, $configuration) {
    138133
    139134        // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
     
    203198 * @uses cache_service_chercher()
    204199 *
    205  * @param string $plugin
    206  *                              Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    207  *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    208  * @param string $fichier_cache
    209  *                              Le chemin complet du fichier à phraser.
    210  * @param array  $configuration
    211  *                              Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
    212  *
    213  * @return array
    214  *               Tableau des composants constitutifs du cache
    215  */
    216 function cache_cache_decomposer($plugin, $fichier_cache, $configuration) {
     200 * @param string $plugin        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     201 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     202 * @param string $fichier_cache Le chemin complet du fichier à phraser.
     203 * @param array  $configuration Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
     204 *
     205 * @return array Tableau des composants constitutifs du cache
     206 */
     207function ezcache_cache_decomposer($plugin, $fichier_cache, $configuration) {
    217208
    218209        // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
     
    259250 * @uses cache_service_chercher()
    260251 *
    261  * @param string $plugin
    262  *                              Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    263  *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    264  * @param array  $cache
    265  *                              Tableau identifiant le cache pour lequel on veut construire le nom.
    266  * @param string $fichier_cache
    267  *                              Fichier cache désigné par son chemin complet.
    268  * @param array  $configuration
    269  *                              Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
    270  *
    271  * @return array
    272  *               Description du cache complétée par un ensemble de données propres au plugin.
    273  */
    274 function cache_cache_completer($plugin, $cache, $fichier_cache, $configuration) {
     252 * @param string $plugin        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     253 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     254 * @param array  $cache         Tableau identifiant le cache pour lequel on veut construire le nom.
     255 * @param string $fichier_cache Fichier cache désigné par son chemin complet.
     256 * @param array  $configuration Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
     257 *
     258 * @return array Description du cache complétée par un ensemble de données propres au plugin.
     259 */
     260function ezcache_cache_completer($plugin, $cache, $fichier_cache, $configuration) {
    275261
    276262        // Cache Factory complète la description avec le nom sans extension et l'extension du fichier cache avant
     
    296282 * @uses cache_service_chercher()
    297283 *
    298  * @param string $plugin
    299  *                              Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    300  *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    301  * @param string $contenu
    302  *                              Contenu du fichier cache au format chaine.
    303  * @param array  $configuration
    304  *                              Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
    305  *
    306  * @return array
    307  *               Contenu du cache décodé si la fonction idoine a été appliqué ou tel que fourni en entrée sinon.
    308  */
    309 function cache_cache_decoder($plugin, $contenu, $configuration) {
     284 * @param string $plugin        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     285 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     286 * @param string $contenu       Contenu du fichier cache au format chaine.
     287 * @param array  $configuration Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
     288 *
     289 * @return array Contenu du cache décodé si la fonction idoine a été appliqué ou tel que fourni en entrée sinon.
     290 */
     291function ezcache_cache_decoder($plugin, $contenu, $configuration) {
    310292
    311293        // Cache Factory décode le contenu du fichier cache en fonction de l'extension (json, yaml, yml ou xml).
     
    353335 * @uses cache_repertorier()
    354336 *
    355  * @param string $plugin
    356  *                              Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    357  *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    358  * @param array  $options
    359  *                              Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     337 * @param string $plugin        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     338 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     339 * @param array  $options       Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
    360340 *                              au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
    361341 *                              Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    362  * @param array  $configuration
    363  *                              Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
    364  *
    365  * @return array
    366  *               Description du cache complétée par un ensemble de données propres au plugin.
    367  */
    368 function cache_cache_formulaire_charger($plugin, $options, $configuration) {
     342 * @param array  $configuration Configuration complète des caches du plugin utilisateur lue à partir de la meta de stockage.
     343 *
     344 * @return array Description du cache complétée par un ensemble de données propres au plugin.
     345 */
     346function ezcache_cache_formulaire_charger($plugin, $options, $configuration) {
    369347
    370348        // Stocker le préfixe et le nom du plugin de façon systématique.
     
    398376 * @internal
    399377 *
    400  * @param string $plugin
    401  *                         Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     378 * @param string $plugin   Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    402379 *                         un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    403  * @param bool   $fonction
    404  *                         Nom de la fonction de service à chercher.
    405  *
    406  * @return string
    407  *                Nom complet de la fonction si trouvée ou chaine vide sinon.
     380 * @param bool   $fonction Nom de la fonction de service à chercher.
     381 *
     382 * @return string Nom complet de la fonction si trouvée ou chaine vide sinon.
    408383 */
    409384function cache_service_chercher($plugin, $fonction) {
     
    412387        // Eviter la réentrance si on demande explicitement le service du plugin Cache Factory.
    413388        if ($plugin != 'cache') {
    414                 include_spip("cache/${plugin}");
     389                include_spip("ezcache/${plugin}");
    415390                $fonction_trouvee = "${plugin}_${fonction}";
    416391                if (!function_exists($fonction_trouvee)) {
  • _plugins_/cache/trunk/formulaires/cache_vider.html

    r113933 r122298  
    1414                ]
    1515                [(#CHEMIN{[formulaires/inc-(#ENV{_prefixe})_cache_vider.html]}|non)
    16                         <INCLURE{fond=formulaires/inc-cache_cache_vider, env} />
     16                        <INCLURE{fond=formulaires/inc-ezcache_cache_vider, env} />
    1717                ]
    1818
  • _plugins_/cache/trunk/formulaires/cache_vider.php

    r122297 r122298  
    1616 * @uses cache_formulaire_charger()
    1717 *
    18  * @param string $plugin
    19  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    20  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    21  * @param array  $options
    22  *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
    23  *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
    24  *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
     18 * @param string $plugin  Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     19 *                        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     20 * @param array  $options Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     21 *                        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     22 *                        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    2523 *
    26  * @return array
    27  *              Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un
    28  *              champ de saisie, celle-ci sont systématiquement remises à zéro. Le tableau comprend à minima l'index suivant:
    29  *              - `_caches`     : (affichage) liste des descriptions des caches rangés par service
     24 * @return array Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un
     25 *               champ de saisie, celle-ci sont systématiquement remises à zéro. Le tableau comprend à minima l'index suivant:
     26 *               - `_caches`    : (affichage) liste des descriptions des caches rangés par service
    3027 */
    3128function formulaires_cache_vider_charger($plugin, $options = array()) {
    3229
    3330        // Lecture de la configuration des caches du plugin.
    34         include_spip('inc/cache');
     31        include_spip('inc/ezcache_cache');
    3532        $configuration = configuration_cache_lire($plugin);
    3633
    3734        // On appelle le service de chargement des variables qui est soit celui par défaut de Cache Factory
    3835        // soit celui spécifique au plugin si il existe.
    39         include_spip('cache/cache');
    40         $valeurs = cache_cache_formulaire_charger($plugin, $options, $configuration);
     36        include_spip('ezcache/ezcache');
     37        $valeurs = ezcache_cache_formulaire_charger($plugin, $options, $configuration);
    4138
    4239        return $valeurs;
    4340}
    4441
    45 
    4642/**
    4743 * Vérification des saisies : il est obligatoire de choisir un cache à supprimer.
    4844 *
    49  * @param string $plugin
    50  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    51  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    52  * @param array  $options
    53  *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
    54  *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
    55  *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
     45 * @param string $plugin  Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     46 *                        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     47 * @param array  $options Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     48 *                        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     49 *                        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    5650 *
    57  * @return array
    58  *              Tableau des erreurs qui se limite à la non sélection d'au moins un cache.
     51 * @return array Tableau des erreurs qui se limite à la non sélection d'au moins un cache.
    5952 */
    6053function formulaires_cache_vider_verifier($plugin, $options = array()) {
    61 
    6254        $erreurs = array();
    6355
    6456        $obligatoires = array('caches');
    6557        foreach ($obligatoires as $_obligatoire) {
    66                 if (!_request($_obligatoire))
     58                if (!_request($_obligatoire)) {
    6759                        $erreurs[$_obligatoire] = _T('info_obligatoire');
     60                }
    6861        }
    6962
     
    7669 * @uses cache_vider()
    7770 *
    78  * @param string $plugin
    79  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    80  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    81  * @param array  $options
    82  *        Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
    83  *        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
    84  *        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
     71 * @param string $plugin  Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     72 *                        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     73 * @param array  $options Tableau d'options qui peut être fourni par un plugin utilisateur uniquement si celui-ci fait appel
     74 *                        au formulaire. La page cache_vider de Cache Factory n'utilise pas ce paramètre.
     75 *                        Le tableau est passé à la fonction de service de chargement du formulaire uniquement.
    8576 *
    86  * @return array
    87  *        Tableau retourné par le formulaire contenant toujours un message de bonne exécution. L'indicateur
    88  *        editable est toujours à vrai.
     77 * @return array Tableau retourné par le formulaire contenant toujours un message de bonne exécution. L'indicateur
     78 *               editable est toujours à vrai.
    8979 */
    9080function formulaires_cache_vider_traiter($plugin, $options = array()) {
    91 
    9281        $retour = array();
    9382
     
    9685
    9786        // On appelle l'API des caches
    98         include_spip('inc/cache');
     87        include_spip('inc/ezcache_cache');
    9988        cache_vider($plugin, $caches);
    10089
  • _plugins_/cache/trunk/inc/ezcache_cache.php

    r122297 r122298  
    99}
    1010
    11 
    1211/**
    1312 * Ecrit un contenu donné dans un cache spécifié par son identifiant relatif ou par son chemin complet.
     
    1615 *
    1716 * @uses configuration_cache_lire()
    18  * @uses cache_cache_composer()
     17 * @uses ezcache_cache_composer()
    1918 * @uses sous_repertoire()
    2019 * @uses ecrire_fichier()
    2120 * @uses ecrire_fichier_securise()
    2221 *
    23  * @param string       $plugin
    24  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    25  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    26  * @param array|string $cache
    27  *        Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
    28  *        les composants canoniques du nom.
    29  * @param array|string $contenu
    30  *        Contenu sous forme de tableau à sérialiser ou sous la forme d'une chaine.
     22 * @param string       $plugin  Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     23 *                              ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     24 * @param array|string $cache   Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
     25 *                              les composants canoniques du nom.
     26 * @param array|string $contenu Contenu sous forme de tableau à sérialiser ou sous la forme d'une chaine.
    3127 *
    3228 * @return bool
    33  *         True si l'écriture s'est bien passée, false sinon.
     29 *              True si l'écriture s'est bien passée, false sinon.
    3430 */
    3531function cache_ecrire($plugin, $cache, $contenu) {
     
    3733        // Initialisation du retour de la fonction
    3834        $cache_ecrit = false;
    39        
     35
    4036        // Lecture de la configuration des caches du plugin.
    4137        $configuration = configuration_cache_lire($plugin);
     
    4440        // tableau permettant de calculer le chemin complet. On prend en compte ces deux cas.
    4541        $fichier_cache = '';
    46         include_spip('cache/cache');
     42        include_spip('ezcache/ezcache');
    4743        if (is_array($cache)) {
    4844                // Vérification de la conformité entre la configuration et le sous-dossier du cache.
     
    5248                        // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    5349                        //   de la configuration du nom pour le plugin.
    54                         $fichier_cache = cache_cache_composer($plugin, $cache, $configuration);
     50                        $fichier_cache = ezcache_cache_composer($plugin, $cache, $configuration);
    5551                }
    5652        } elseif (is_string($cache)) {
     
    5854                // il faut donc que l'appelant ait utilisé l'API pour calculer le fichier au préalable.
    5955                $fichier_cache = $cache;
    60                 $cache = cache_cache_decomposer($plugin, $fichier_cache, $configuration);
    61         }
    62        
     56                $cache = ezcache_cache_decomposer($plugin, $fichier_cache, $configuration);
     57        }
     58
    6359        if ($fichier_cache) {
    6460                // On crée les répertoires si besoin
     
    7268                }
    7369
    74                 // Suivant que la configuration demande une sérialisation ou pas, on vérife le format du contenu
     70                // Suivant que la configuration demande une sérialisation ou pas, on vérife le format du contenu
    7571                // de façon à toujours écrire une chaine.
    7672                $contenu_cache = '';
     
    108104                }
    109105        }
    110        
     106
    111107        return $cache_ecrit;
    112108}
    113 
    114109
    115110/**
     
    121116 *
    122117 * @uses configuration_cache_lire()
    123  * @uses cache_cache_composer()
     118 * @uses ezcache_cache_composer()
    124119 * @uses lire_fichier()
    125120 * @uses lire_fichier_securise()
    126121 *
    127  * @param string       $plugin
    128  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    129  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    130  * @param array|string $cache
    131  *        Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
    132  *        les composants canoniques du nom.
    133  *
    134  * @return array|string|bool
    135  *        Contenu du fichier sous la forme d'un tableau, d'une chaine ou false si une erreur s'est produite.
     122 * @param string       $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     123 *                             ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     124 * @param array|string $cache  Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
     125 *                             les composants canoniques du nom.
     126 *
     127 * @return array|bool|string Contenu du fichier sous la forme d'un tableau, d'une chaine ou false si une erreur s'est produite.
    136128 */
    137129function cache_lire($plugin, $cache) {
     
    146138        // tableau permettant de calculer le chemin complet. On prend en compte ces deux cas.
    147139        $fichier_cache = '';
    148         include_spip('cache/cache');
     140        include_spip('ezcache/ezcache');
    149141        if (is_array($cache)) {
    150142                // Détermination du chemin du cache :
    151143                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    152144                //   de la configuration du nom pour le plugin.
    153                 $fichier_cache = cache_cache_composer($plugin, $cache, $configuration);
     145                $fichier_cache = ezcache_cache_composer($plugin, $cache, $configuration);
    154146        } elseif (is_string($cache)) {
    155147                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
     
    168160                $contenu_cache = '';
    169161                $lecture_ok = $lire($fichier_cache, $contenu_cache);
    170                
     162
    171163                if ($lecture_ok) {
    172164                        if ($configuration['serialisation']) {
     
    175167                                $cache_lu = $contenu_cache;
    176168                                if ($configuration['decodage']) {
    177                                         $cache_lu = cache_cache_decoder($plugin, $cache_lu, $configuration);
     169                                        $cache_lu = ezcache_cache_decoder($plugin, $cache_lu, $configuration);
    178170                                }
    179171                        }
     
    183175        return $cache_lu;
    184176}
    185 
    186177
    187178/**
     
    193184 *
    194185 * @uses configuration_cache_lire()
    195  * @uses cache_cache_composer()
    196  *
    197  * @param string       $plugin
    198  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    199  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    200  * @param array|string $cache
    201  *        Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
    202  *        les composants canoniques du nom.
    203  *
    204  * @return string
    205  *         Le chemin complet du fichier si valide, la chaine vide sinon.
     186 * @uses ezcache_cache_composer()
     187 *
     188 * @param string       $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     189 *                             ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     190 * @param array|string $cache  Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
     191 *                             les composants canoniques du nom.
     192 *
     193 * @return string Le chemin complet du fichier si valide, la chaine vide sinon.
    206194 */
    207195function cache_est_valide($plugin, $cache) {
     
    217205                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    218206                //   de la configuration du nom pour le plugin.
    219                 include_spip('cache/cache');
    220                 $fichier_cache = cache_cache_composer($plugin, $cache, $configuration);
     207                include_spip('ezcache/ezcache');
     208                $fichier_cache = ezcache_cache_composer($plugin, $cache, $configuration);
    221209        } elseif (is_string($cache)) {
    222210                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
     
    247235}
    248236
    249 
    250237/**
    251238 * Renvoie le chemin complet du cache sans tester son existence.
    252  * Cette fonction est une encapsulation du service cache_cache_composer().
     239 * Cette fonction est une encapsulation du service ezcache_cache_composer().
    253240 *
    254241 * @api
    255242 *
    256243 * @uses configuration_cache_lire()
    257  * @uses cache_cache_composer()
    258  *
    259  * @param string $plugin
    260  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    261  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    262  * @param array  $cache
    263  *        Identifiant du cache sous la forme d'un tableau fournissant les composants canoniques du nom.
     244 * @uses ezcache_cache_composer()
     245 *
     246 * @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     247 *                       ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     248 * @param array  $cache  Identifiant du cache sous la forme d'un tableau fournissant les composants canoniques du nom.
    264249 *
    265250 * @return string
     
    276261                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    277262                //   de la configuration du nom pour le plugin.
    278                 include_spip('cache/cache');
    279                 $fichier_cache = cache_cache_composer($plugin, $cache, $configuration);
     263                include_spip('ezcache/ezcache');
     264                $fichier_cache = ezcache_cache_composer($plugin, $cache, $configuration);
    280265        }
    281266
     
    283268}
    284269
    285 
    286270/**
    287271 * Supprime le cache spécifié par son identifiant relatif ou par son chemin complet.
     
    290274 *
    291275 * @uses configuration_cache_lire()
    292  * @uses cache_cache_composer()
     276 * @uses ezcache_cache_composer()
    293277 * @uses supprimer_fichier()
    294278 *
    295  * @param string       $plugin
    296  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    297  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    298  * @param array|string $cache
    299  *        Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
    300  *        les composants canoniques du nom.
    301  *
    302  * @return bool
    303  *         True si la suppression s'est bien passée, false sinon.
     279 * @param string       $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     280 *                             ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     281 * @param array|string $cache  Identifiant du cache sous la forme d'une chaine (le chemin du fichier) ou d'un tableau fournissant
     282 *                             les composants canoniques du nom.
     283 *
     284 * @return bool `true` si la suppression s'est bien passée, `false` sinon.
    304285 */
    305286function cache_supprimer($plugin, $cache) {
     
    314295        // tableau permettant de calculer le chemin complet. On prend en compte ces deux cas.
    315296        $fichier_cache = '';
    316         include_spip('cache/cache');
     297        include_spip('ezcache/ezcache');
    317298        if (is_array($cache)) {
    318299                // Détermination du chemin du cache :
    319300                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    320301                //   de la configuration du nom pour le plugin.
    321                 $fichier_cache = cache_cache_composer($plugin, $cache, $configuration);
     302                $fichier_cache = ezcache_cache_composer($plugin, $cache, $configuration);
    322303        } elseif (is_string($cache)) {
    323304                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
    324305                // il faut donc que l'appelant ait utilisé l'API cache_existe() pour calculer le fichier au préalable.
    325306                $fichier_cache = $cache;
    326                 $cache = cache_cache_decomposer($plugin, $fichier_cache, $configuration);
     307                $cache = ezcache_cache_decomposer($plugin, $fichier_cache, $configuration);
    327308        }
    328309
     
    350331}
    351332
    352 
    353333/**
    354334 * Retourne la description des caches d'un plugin utilisateur filtrée sur un ensemble de critères. La description
     
    360340 *
    361341 * @uses configuration_cache_lire()
    362  * @uses cache_cache_decomposer()
    363  * @uses cache_cache_completer()
    364  *
    365  * @param string       $plugin
    366  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    367  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    368  * @param array $filtres
    369  *        Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les composants
    370  *        de caches. Les opérateurs égalité et inégalité sont possibles.
    371  *
    372  * @return array
    373  *        Tableau des descriptions des fichiers cache créés par le plugin indexé par le chemin complet de
    374  *        chaque fichier cache.
     342 * @uses ezcache_cache_decomposer()
     343 * @uses ezcache_cache_completer()
     344 *
     345 * @param string $plugin  Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     346 *                        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     347 * @param array  $filtres Tableau associatif `[champ] = valeur` ou `[champ] = !valeur` de critères de filtres sur les composants
     348 *                        de caches. Les opérateurs égalité et inégalité sont possibles.
     349 *
     350 * @return array Tableau des descriptions des fichiers cache créés par le plugin indexé par le chemin complet de
     351 *               chaque fichier cache.
    375352 */
    376353function cache_repertorier($plugin, $filtres = array()) {
     
    402379                foreach ($fichiers_cache as $_fichier_cache) {
    403380                        // On décompose le chemin de chaque cache afin de renvoyer l'identifiant canonique du cache.
    404                         include_spip('cache/cache');
    405                         $cache = cache_cache_decomposer($plugin, $_fichier_cache, $configuration);
     381                        include_spip('ezcache/ezcache');
     382                        $cache = ezcache_cache_decomposer($plugin, $_fichier_cache, $configuration);
    406383
    407384                        // Maintenant que les composants sont déterminés on applique les filtres pour savoir si on
     
    425402                        if ($cache_conforme) {
    426403                                // On permet au plugin de completer la description canonique
    427                                 $cache = cache_cache_completer($plugin, $cache, $_fichier_cache, $configuration);
     404                                $cache = ezcache_cache_completer($plugin, $cache, $_fichier_cache, $configuration);
    428405
    429406                                // On stocke la description du fichier cache dans le tableau de sortie.
     
    436413}
    437414
    438 
    439415/**
    440416 * Supprime, pour un plugin donné, les caches désignés par leur chemin complet.
     
    444420 * @uses supprimer_fichier()
    445421 *
    446  * @param string $plugin
    447  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    448  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    449  * @param array  $caches
    450  *        Liste des fichiers caches désignés par leur chemin complet.
    451  *
    452  * @return bool
    453  *         True si la suppression s'est bien passée, false sinon.
     422 * @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     423 *                       ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     424 * @param array  $caches Liste des fichiers caches désignés par leur chemin complet.
     425 *
     426 * @return bool `true` si la suppression s'est bien passée, `false` sinon.
    454427 */
    455428function cache_vider($plugin, $caches) {
     
    466439
    467440                // Suppression des caches
    468                 include_spip('cache/cache');
     441                include_spip('ezcache/ezcache');
    469442                include_spip('inc/flock');
    470443                foreach ($fichiers_cache as $_fichier) {
     
    478451                                        'fonction'      => 'supprimer',
    479452                                        'fichier_cache' => $_fichier,
    480                                         'cache'         => cache_cache_decomposer($plugin, $_fichier, $configuration),
     453                                        'cache'         => ezcache_cache_decomposer($plugin, $_fichier, $configuration),
    481454                                        'configuration' => $configuration
    482455                                ),
     
    486459                $cache_vide = true;
    487460        }
    488        
     461
    489462        return $cache_vide;
    490463}
    491 
    492464
    493465/**
     
    498470 *
    499471 * @uses lire_config()
    500  * @uses cache_cache_configurer()
    501  *
    502  * @param string $plugin
    503  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    504  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    505  *        Si vide, toutes les configurations sont fournies.
    506  *
    507  * @return array
    508  *        Tableau de configuration des caches d'un plugin utilisateur ou tableau vide si aucune configuration n'est encore
    509  *        enregistrée.
     472 * @uses ezcache_cache_configurer()
     473 *
     474 * @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     475 *                       ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     476 *                       Si vide, toutes les configurations sont fournies.
     477 *
     478 * @return array Tableau de configuration des caches d'un plugin utilisateur ou tableau vide si aucune configuration n'est encore
     479 *               enregistrée.
    510480 */
    511481function configuration_cache_lire($plugin = '') {
    512 
    513482        static $configuration = array();
    514483
     
    518487                // Lecture de la configuration des caches du plugin. Si celle-ci n'existe pas encore elle est créée.
    519488                if (empty($configuration[$plugin]) and (!$configuration[$plugin] = lire_config("cache/${plugin}", array()))) {
    520                         include_spip('cache/cache');
    521                         $configuration[$plugin] = cache_cache_configurer($plugin);
     489                        include_spip('ezcache/ezcache');
     490                        $configuration[$plugin] = ezcache_cache_configurer($plugin);
    522491                }
    523492                $configuration_lue = $configuration[$plugin];
     
    529498}
    530499
    531 
    532500/**
    533501 * Efface la configuration standard des caches d'un plugin utilisateur ou de tous les plugins utilisateur
     
    539507 * @uses effacer_config()
    540508 *
    541  * @param string $plugin
    542  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    543  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    544  *        Si vide, toutes les configurations sont effacées.
    545  *
    546  * @return bool
    547  *         True si la suppression s'est bien passée, false sinon.
     509 * @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     510 *                       ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     511 *                       Si vide, toutes les configurations sont effacées.
     512 *
     513 * @return bool `true` si la suppression s'est bien passée, `false` sinon.
    548514 */
    549515function configuration_cache_effacer($plugin = '') {
  • _plugins_/cache/trunk/lang/cache_fr.php

    r114408 r122298  
    55
    66$GLOBALS[$GLOBALS['idx_lang']] = array(
     7        // C
     8        'cache_vider_titre_form'   => 'Caches du plugin @plugin@',
     9        'cache_vider_titre_page'   => 'Cache Factory',
     10        'cache_vider_menu'         => 'Vider les caches des plugins',
     11        'cache_vider_label_choix'  => 'Choisir les caches à supprimer',
     12        'cache_vider_notice_aucun' => 'Aucun cache n\'a encore été créé par le plugin.',
     13        'cache_vider_succes'       => 'Les caches sélectionnés ont bien été supprimés.',
     14        'cache_vider_cocher_rien'  => 'Tout décocher',
     15        'cache_vider_cocher_tout'  => 'Tout cocher',
    716
    8 // C
    9         'cache_vider_titre_form' => 'Caches du plugin @plugin@',
    10         'cache_vider_titre_page' => 'Cache Factory',
    11         'cache_vider_menu' => 'Vider les caches des plugins',
    12         'cache_vider_label_choix' => 'Choisir les caches à supprimer',
    13         'cache_vider_notice_aucun' => 'Aucun cache n\'a encore été créé par le plugin.',
    14         'cache_vider_succes' => 'Les caches sélectionnés ont bien été supprimés.',
    15         'cache_vider_cocher_rien' => 'Tout décocher',
    16         'cache_vider_cocher_tout' => 'Tout cocher',
     17        // I
     18        'info_1_cache'     => 'Un cache',
     19        'info_nb_cache'    => '@nb@ caches',
     20        'info_aucun_cache' => 'Aucun cache',
    1721);
  • _plugins_/cache/trunk/paquet.xml

    r122297 r122298  
    11<paquet
    2         prefix="cache"
     2        prefix="ezcache"
    33        categorie="outil"
    44        version="0.6.0"
Note: See TracChangeset for help on using the changeset viewer.