Changeset 113748 in spip-zone

Timestamp:

Feb 5, 2019, 2:20:48 PM (18 months ago)

Author:

eric@…

Message:

Renommage et PHPDoc

Location:

_plugins_/cache/trunk

Files:

• cache/cache.php (modified) (8 diffs)
• inc/cache_api.php (modified) (7 diffs)
• paquet.xml (modified) (1 diff)

_plugins_/cache/trunk/cache/cache.php

@@ -42 +42 @@
 }
 
-if (!defined('_CACHE_SEPARATEUR')) {
+if (!defined('_CACHE_NOM_SEPARATEUR')) {
         /**
          * Dossier racine dans lesquels tous les caches par défaut seront rangés.
          * Les caches sont répartis suivant le plugin appelant dans un sous-dossier `/${plugin}`.
          */
-        define('_CACHE_SEPARATEUR', '_');
+        define('_CACHE_NOM_SEPARATEUR', '_');
 }
 
@@ -56 +56 @@
 
 /**
- * Complète la description d'un type de noisette issue de la lecture de son fichier YAML.
- *
- * Le plugin N-Core ne complète pas les types de noisette.
- *
- * @uses ncore_chercher_service()
+ * Récupère la configuration des caches d'un plugin, la complète et la stocke dans une meta.
+ *
+ * Le plugin Cache Factory propose une configuration par défaut des caches.
+ *
+ * @uses cache_chercher_service()
  * @uses sous_repertoire()
  * @uses lire_config()
@@ -68 +68 @@
  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
  *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- * @param array  $description
- *        Description du type de noisette issue de la lecture du fichier YAML. Suivant le plugin utilisateur elle
- *        nécessite d'être compléter avant son stockage.
- * @param string $stockage
- *        Identifiant du service de stockage à utiliser si précisé.
  *
  * @return array
- *        Description du type de noisette éventuellement complétée par le plugin utilisateur.
+ *        Tableau de la configuration complétée des caches d'un plugin venant d'être enregistrée.
  */
 function cache_cache_configurer($plugin) {
@@ -86 +81 @@
                 'securisation'  => _CACHE_SECURISE,
                 'serialisation' => _CACHE_CONTENU_SERIALISE,
-                'separateur'    => _CACHE_SEPARATEUR
+                'separateur'    => _CACHE_NOM_SEPARATEUR
         );
 
@@ -137 +132 @@
  * Construit le chemin complet du fichier cache.
  *
- * @uses ncore_chercher_service()
+ * @uses cache_chercher_service()
  *
  * @param string $plugin
  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
  *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
- * @param array  $conteneur
+ * @param array  $cache
  *        Tableau identifiant le cache pour lequel on veut construire le nom.
  * @param array  $configuration
- *        Configuration complète des caches du plugin utlisateur.
+ *        Configuration complète des caches du plugin utlisateur lue à partir de la meta de stockage.
  *
  * @return string
  */
-function cache_cache_nommer($plugin, $conteneur, $configuration) {
+function cache_cache_nommer($plugin, $cache, $configuration) {
 
         // Le plugin utilisateur peut fournir un service propre pour construire le chemin complet du fichier cache.
@@ -155 +150 @@
         if ($nommer = cache_chercher_service($plugin, 'cache_nommer')) {
                 // On passe le plugin appelant à la fonction car cela permet ainsi de mutualiser les services de stockage.
-                $fichier_cache = $nommer($plugin, $conteneur, $configuration);
+                $fichier_cache = $nommer($plugin, $cache, $configuration);
         } else {
                 // On utilise le mécanisme de nommage standard du plugin Cache.
@@ -164 +159 @@
                 // de base des caches du plugin.
                 $dir_cache = $configuration['dossier_base'];
-                if (!empty($conteneur['sous_dossier'])) {
-                        // Si le conteneur nécessite un sous-dossier, appelé service dans l'identifiant du conteneur.
-                        $dir_cache .= rtrim($conteneur['sous_dossier'], '/');
+                if (!empty($cache['sous_dossier'])) {
+                        // Si le cache nécessite un sous-dossier, appelé service dans l'identifiant du cache.
+                        $dir_cache .= rtrim($cache['sous_dossier'], '/');
                 }
 
                 // Détermination du nom du cache sans extension.
-                // Celui-ci est construit à partir des éléments fournis sur le conteneur et de la configuration
+                // Celui-ci est construit à partir des éléments fournis sur le cache et de la configuration
                 // fournie par le plugin (liste ordonnée de composant).
                 $nom_cache = '';
                 foreach ($configuration['nom'] as $_composant) {
-                        if (isset($conteneur[$_composant])) {
-                                $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $conteneur[$_composant];
+                        if (isset($cache[$_composant])) {
+                                $nom_cache .= ($nom_cache ? $configuration['separateur'] : '') . $cache[$_composant];
                         }
                 }
@@ -184 +179 @@
                         // Par contre, si le cache est sécurisé alors on ne tient pas compte du forçage éventuel car l'extension
                         // doit toujours être .php et celle-ci a été forcée lors de la configuration des caches du plugin.
-                        $extension = (!empty($conteneur['extension']) and !$configuration['securisation'])
-                                ? $conteneur['extension']
+                        $extension = (!empty($cache['extension']) and !$configuration['securisation'])
+                                ? $cache['extension']
                                 : $configuration['extension'];
                         // Le chemin complet

_plugins_/cache/trunk/inc/cache_api.php

@@ -1 +1 @@
 <?php
 /**
- * Ce fichier contient les fonctions d'API de gestion des caches.
+ * Ce fichier contient les fonctions d'API du plugin Cache Factory.
  *
  * @package SPIP\CACHE\API
@@ -15 +15 @@
  * @api
  *
+ * @uses cache_configuration_lire()
  * @uses cache_cache_configurer()
  * @uses cache_cache_nommer()
@@ -96 +97 @@
  * @api
  *
+ * @uses cache_configuration_lire()
  * @uses cache_cache_configurer()
  * @uses cache_cache_nommer()
@@ -164 +166 @@
  * @api
  *
+ * @uses cache_configuration_lire()
  * @uses cache_cache_configurer()
  * @uses cache_cache_nommer()
@@ -216 +219 @@
  * @api
  *
+ * @uses cache_configuration_lire()
+ * @uses cache_cache_configurer()
  * @uses cache_cache_nommer()
  *
@@ -253 +258 @@
  * @api
  *
+ * @uses cache_configuration_lire()
  * @uses cache_cache_configurer()
  * @uses cache_cache_nommer()
@@ -341 +347 @@
  * @api
  *
+ * @uses lire_config()
+ *
  * @param string $plugin
  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier

_plugins_/cache/trunk/paquet.xml

@@ -8 +8 @@
 >
         <nom>Cache Factory</nom>
-        <!-- Une fabrique de caches transparente -->
+        <!-- La fabrique de caches pour plugins -->
 
         <auteur lien="http://blog.smellup.net">Eric Lupinacci</auteur>