Changeset 113780 in spip-zone


Ignore:
Timestamp:
Feb 6, 2019, 10:07:23 AM (18 months ago)
Author:
eric@…
Message:

Quelques corrections, simplifications et renommages

Location:
_plugins_/cache/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • _plugins_/cache/trunk/cache/cache.php

    r113748 r113780  
    55 * Chaque fonction, soit aiguille, si elle existe, vers une fonction "homonyme" propre au plugin appelant
    66 * soit déroule sa propre implémentation.
    7  * Ainsi, les plugins externes peuvent, si elle leur convient, utiliser l'implémentation proposée par Cache.
     7 * Ainsi, les plugins externes peuvent, si elle leur convient, utiliser l'implémentation proposée par Cache Factory.
    88 *
    99 * @package SPIP\CACHE\SERVICE
    … …  
    4444if (!defined('_CACHE_NOM_SEPARATEUR')) {
    4545        /**
    46          * Dossier racine dans lesquels tous les caches par défaut seront rangés.
    47          * Les caches sont répartis suivant le plugin appelant dans un sous-dossier `/${plugin}`.
     46         * Caractère séparateur des composants du nom d'un fichier cache.
     47         * De fait, ce caractère ne doit pas être utilisé dans les composants.
    4848         */
    4949        define('_CACHE_NOM_SEPARATEUR', '_');
    … …  
    110110                $configuration['racine'] = $configuration_defaut['racine'];
    111111        } else {
     112                // On s'assure que la racine se termine toujours par un slash.
    112113                $configuration['racine'] = rtrim($configuration['racine'], '/') . '/';
    113114        }
    … …  
    115116        $sous_dossier = ($configuration['racine'] == _DIR_VAR) ? "cache-${plugin}" : "$plugin";
    116117        // -- Création et enregistrement du dossier de base
    117         sous_repertoire($configuration['racine'], $sous_dossier);
    118         $configuration['dossier_base'] = $configuration['racine'] . "${sous_dossier}/";
     118        include_spip('inc/flock');
     119        $configuration['dossier_base'] = sous_repertoire($configuration['racine'], $sous_dossier);
    119120       
    120121        // Enregistrement de la configuration du plugin utilisateur dans la meta prévue.
    … …  
    144145 * @return string
    145146 */
    146 function cache_cache_nommer($plugin, $cache, $configuration) {
     147function cache_cache_composer($plugin, $cache, $configuration) {
    147148
    148149        // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
    … …  
    161162                if (!empty($cache['sous_dossier'])) {
    162163                        // Si le cache nécessite un sous-dossier, appelé service dans l'identifiant du cache.
    163                         $dir_cache .= rtrim($cache['sous_dossier'], '/');
     164                        $dir_cache .= rtrim($cache['sous_dossier'], '/') . '/';
    164165                }
    165166

  • _plugins_/cache/trunk/inc/cache.php

    r113757 r113780  
    1717 * @uses cache_configuration_lire()
    1818 * @uses cache_cache_configurer()
    19  * @uses cache_cache_nommer()
     19 * @uses cache_cache_composer()
    2020 *
    2121 * @param string        $plugin
    … …  
    4747        // tableau permettant de calculer le chemin complet. On prend en compte ces deux cas.
    4848        $fichier_cache = '';
     49        include_spip('inc/flock');
    4950        if (is_array($cache)) {
    5051                // Création du répertoire du cache à créer, si besoin.
    … …  
    5758                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    5859                //   de la configuration du nom pour le plugin.
    59                 $fichier_cache = cache_cache_nommer($plugin, $cache, $configuration[$plugin]);
     60                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
    6061        } elseif (is_string($cache)) {
    6162                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
    62                 // il faut donc que l'appelant ait utilisé l'API cache_existe() pour calculer le fichier au préalable.
     63                // il faut donc que l'appelant ait utilisé l'API pour calculer le fichier au préalable.
    6364                $fichier_cache = $cache;
    6465        }
    6566       
    6667        if ($fichier_cache) {
    67                 // Suivant que la configuration demande un sérialisation ou pas, on vérife le format du contenu
     68                // Suivant que la configuration demande une sérialisation ou pas, on vérife le format du contenu
    6869                // de façon à toujours écrire une chaine.
    6970                $contenu_cache = '';
    … …  
    8081
    8182                // Ecriture du fichier cache sécurisé ou pas suivant la configuration.
    82                 include_spip('inc/flock');
    8383                $ecrire = 'ecrire_fichier';
    8484                if ($configuration[$plugin]['securisation']) {
    … …  
    100100 * @uses cache_configuration_lire()
    101101 * @uses cache_cache_configurer()
    102  * @uses cache_cache_nommer()
     102 * @uses cache_cache_composer()
    103103 *
    104104 * @param string        $plugin
    … …  
    132132                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    133133                //   de la configuration du nom pour le plugin.
    134                 $fichier_cache = cache_cache_nommer($plugin, $cache, $configuration[$plugin]);
     134                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
    135135        } elseif (is_string($cache)) {
    136136                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
    137                 // il faut donc que l'appelant ait utilisé l'API cache_existe() pour calculer le fichier au préalable.
     137                // il faut donc que l'appelant ait utilisé l'API pour calculer le fichier au préalable.
    138138                $fichier_cache = $cache;
    139139        }
    … …  
    170170 * @uses cache_configuration_lire()
    171171 * @uses cache_cache_configurer()
    172  * @uses cache_cache_nommer()
     172 * @uses cache_cache_composer()
    173173 *
    174174 * @param string        $plugin
    … …  
    198198                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    199199                //   de la configuration du nom pour le plugin.
    200                 $fichier_cache = cache_cache_nommer($plugin, $cache, $configuration[$plugin]);
     200                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
    201201        } elseif (is_string($cache)) {
    202202                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
    … …  
    218218/**
    219219 * Renvoie le chemin complet du cache sans tester son existence.
    220  * Cette fonction est une encapsulation du service cache_cache_nommer().
    221  *
    222  * @api
    223  *
    224  * @uses cache_configuration_lire()
    225  * @uses cache_cache_configurer()
    226  * @uses cache_cache_nommer()
     220 * Cette fonction est une encapsulation du service cache_cache_composer().
     221 *
     222 * @api
     223 *
     224 * @uses cache_configuration_lire()
     225 * @uses cache_cache_configurer()
     226 * @uses cache_cache_composer()
    227227 *
    228228 * @param string $plugin
    … …  
    250250                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    251251                //   de la configuration du nom pour le plugin.
    252                 $fichier_cache = cache_cache_nommer($plugin, $cache, $configuration[$plugin]);
     252                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
    253253        }
    254254
    … …  
    264264 * @uses cache_configuration_lire()
    265265 * @uses cache_cache_configurer()
    266  * @uses cache_cache_nommer()
     266 * @uses cache_cache_composer()
    267267 * @uses supprimer_fichier()
    268268 *
    … …  
    297297                // - le nom sans extension est construit à partir des éléments fournis sur le conteneur et
    298298                //   de la configuration du nom pour le plugin.
    299                 $fichier_cache = cache_cache_nommer($plugin, $cache, $configuration[$plugin]);
     299                $fichier_cache = cache_cache_composer($plugin, $cache, $configuration[$plugin]);
    300300        } elseif (is_string($cache)) {
    301301                // Le chemin complet du fichier cache est fourni. Aucune vérification ne peut être faite
Note: See TracChangeset for help on using the changeset viewer.