Changeset 113748 in spip-zone


Ignore:
Timestamp:
Feb 5, 2019, 2:21:03 PM (12 days ago)
Author:
root
Message:

Renommage et PHPDoc

Location:
_plugins_/cache/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/cache/trunk/cache/cache.php

    r113747 r113748  
    4242}
    4343
    44 if (!defined('_CACHE_SEPARATEUR')) {
     44if (!defined('_CACHE_NOM_SEPARATEUR')) {
    4545        /**
    4646         * Dossier racine dans lesquels tous les caches par défaut seront rangés.
    4747         * Les caches sont répartis suivant le plugin appelant dans un sous-dossier `/${plugin}`.
    4848         */
    49         define('_CACHE_SEPARATEUR', '_');
     49        define('_CACHE_NOM_SEPARATEUR', '_');
    5050}
    5151
     
    5656
    5757/**
    58  * Complète la description d'un type de noisette issue de la lecture de son fichier YAML.
    59  *
    60  * Le plugin N-Core ne complète pas les types de noisette.
    61  *
    62  * @uses ncore_chercher_service()
     58 * Récupère la configuration des caches d'un plugin, la complète et la stocke dans une meta.
     59 *
     60 * Le plugin Cache Factory propose une configuration par défaut des caches.
     61 *
     62 * @uses cache_chercher_service()
    6363 * @uses sous_repertoire()
    6464 * @uses lire_config()
     
    6868 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    6969 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    70  * @param array  $description
    71  *        Description du type de noisette issue de la lecture du fichier YAML. Suivant le plugin utilisateur elle
    72  *        nécessite d'être compléter avant son stockage.
    73  * @param string $stockage
    74  *        Identifiant du service de stockage à utiliser si précisé.
    7570 *
    7671 * @return array
    77  *        Description du type de noisette éventuellement complétée par le plugin utilisateur.
     72 *        Tableau de la configuration complétée des caches d'un plugin venant d'être enregistrée.
    7873 */
    7974function cache_cache_configurer($plugin) {
     
    8681                'securisation'  => _CACHE_SECURISE,
    8782                'serialisation' => _CACHE_CONTENU_SERIALISE,
    88                 'separateur'    => _CACHE_SEPARATEUR
     83                'separateur'    => _CACHE_NOM_SEPARATEUR
    8984        );
    9085
     
    137132 * Construit le chemin complet du fichier cache.
    138133 *
    139  * @uses ncore_chercher_service()
     134 * @uses cache_chercher_service()
    140135 *
    141136 * @param string $plugin
    142137 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    143138 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    144  * @param array  $conteneur
     139 * @param array  $cache
    145140 *        Tableau identifiant le cache pour lequel on veut construire le nom.
    146141 * @param array  $configuration
    147  *        Configuration complète des caches du plugin utlisateur.
     142 *        Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
    148143 *
    149144 * @return string
    150145 */
    151 function cache_cache_nommer($plugin, $conteneur, $configuration) {
     146function cache_cache_nommer($plugin, $cache, $configuration) {
    152147
    153148        // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
     
    155150        if ($nommer = cache_chercher_service($plugin, 'cache_nommer')) {
    156151                // On passe le plugin appelant à la fonction car cela permet ainsi de mutualiser les services de stockage.
    157                 $fichier_cache = $nommer($plugin, $conteneur, $configuration);
     152                $fichier_cache = $nommer($plugin, $cache, $configuration);
    158153        } else {
    159154                // On utilise le mécanisme de nommage standard du plugin Cache.
     
    164159                // de base des caches du plugin.
    165160                $dir_cache = $configuration['dossier_base'];
    166                 if (!empty($conteneur['sous_dossier'])) {
    167                         // Si le conteneur nécessite un sous-dossier, appelé service dans l'identifiant du conteneur.
    168                         $dir_cache .= rtrim($conteneur['sous_dossier'], '/');
     161                if (!empty($cache['sous_dossier'])) {
     162                        // Si le cache nécessite un sous-dossier, appelé service dans l'identifiant du cache.
     163                        $dir_cache .= rtrim($cache['sous_dossier'], '/');
    169164                }
    170165
    171166                // Détermination du nom du cache sans extension.
    172                 // Celui-ci est construit à partir des éléments fournis sur le conteneur et de la configuration
     167                // Celui-ci est construit à partir des éléments fournis sur le cache et de la configuration
    173168                // fournie par le plugin (liste ordonnée de composant).
    174169                $nom_cache = '';
    175170                foreach ($configuration['nom'] as $_composant) {
    176                         if (isset($conteneur[$_composant])) {
    177                                 $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $conteneur[$_composant];
     171                        if (isset($cache[$_composant])) {
     172                                $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $cache[$_composant];
    178173                        }
    179174                }
     
    184179                        // Par contre, si le cache est sécurisé alors on ne tient pas compte du forçage éventuel car l'extension
    185180                        // doit toujours être .php et celle-ci a été forcée lors de la configuration des caches du plugin.
    186                         $extension = (!empty($conteneur['extension']) and !$configuration['securisation'])
    187                                 ? $conteneur['extension']
     181                        $extension = (!empty($cache['extension']) and !$configuration['securisation'])
     182                                ? $cache['extension']
    188183                                : $configuration['extension'];
    189184                        // Le chemin complet
  • _plugins_/cache/trunk/inc/cache_api.php

    r113747 r113748  
    11<?php
    22/**
    3  * Ce fichier contient les fonctions d'API de gestion des caches.
     3 * Ce fichier contient les fonctions d'API du plugin Cache Factory.
    44 *
    55 * @package SPIP\CACHE\API
     
    1515 * @api
    1616 *
     17 * @uses cache_configuration_lire()
    1718 * @uses cache_cache_configurer()
    1819 * @uses cache_cache_nommer()
     
    9697 * @api
    9798 *
     99 * @uses cache_configuration_lire()
    98100 * @uses cache_cache_configurer()
    99101 * @uses cache_cache_nommer()
     
    164166 * @api
    165167 *
     168 * @uses cache_configuration_lire()
    166169 * @uses cache_cache_configurer()
    167170 * @uses cache_cache_nommer()
     
    216219 * @api
    217220 *
     221 * @uses cache_configuration_lire()
     222 * @uses cache_cache_configurer()
    218223 * @uses cache_cache_nommer()
    219224 *
     
    253258 * @api
    254259 *
     260 * @uses cache_configuration_lire()
    255261 * @uses cache_cache_configurer()
    256262 * @uses cache_cache_nommer()
     
    341347 * @api
    342348 *
     349 * @uses lire_config()
     350 *
    343351 * @param string $plugin
    344352 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
  • _plugins_/cache/trunk/paquet.xml

    r113741 r113748  
    88>
    99        <nom>Cache Factory</nom>
    10         <!-- Une fabrique de caches transparente -->
     10        <!-- La fabrique de caches pour plugins -->
    1111
    1212        <auteur lien="http://blog.smellup.net">Eric Lupinacci</auteur>
Note: See TracChangeset for help on using the changeset viewer.