Changeset 113822 in spip-zone


Ignore:
Timestamp:
Feb 8, 2019, 6:08:09 PM (2 years ago)
Author:
eric@…
Message:

Suppression de fonctions inutiles et phpdoc

Location:
_plugins_/taxonomie/trunk
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • _plugins_/taxonomie/trunk/inc/taxonomie_cacher.php

    r113820 r113822  
    77if (!defined('_ECRIRE_INC_VERSION')) {
    88        return;
    9 }
    10 
    11 
    12 if (!defined('_TAXONOMIE_CACHE_NOMDIR')) {
    13         /**
    14          * Nom du dossier contenant les fichiers caches des éléments de taxonomie
    15          *
    16          * @package SPIP\TAXONOMIE\CACHE
    17          */
    18         define('_TAXONOMIE_CACHE_NOMDIR', 'cache-taxonomie/');
    19 }
    20 if (!defined('_TAXONOMIE_CACHE_DIR')) {
    21         /**
    22          * Chemin du dossier contenant les fichiers caches des boussoles
    23          *
    24          * @package SPIP\TAXONOMIE\CACHE
    25          */
    26         define('_TAXONOMIE_CACHE_DIR', _DIR_VAR . _TAXONOMIE_CACHE_NOMDIR);
    27 }
    28 if (!defined('_TAXONOMIE_CACHE_FORCER')) {
    29         /**
    30          * Indicateur permettant de forcer le recalcul du cache systématiquement.
    31          * A n'utiliser que temporairement en mode debug par exemple.
    32          *
    33          * @package SPIP\TAXONOMIE\CACHE
    34          */
    35         define('_TAXONOMIE_CACHE_FORCER', false);
    36 }
    37 
    38 
    39 /**
    40  * Ecrit le contenu issu d'un service taxonomique dans un fichier texte afin d'optimiser le nombre
    41  * de requêtes adressées au service.
    42  *
    43  * @package SPIP\TAXONOMIE\CACHE
    44  *
    45  * @param string $cache
    46  *        Contenu du fichier cache. Si le service appelant manipule un tableau il doit le sérialiser avant
    47  *        d'appeler cette fonction.
    48  * @param string $service
    49  * @param string $action
    50  * @param int    $tsn
    51  * @param array  $options
    52  *
    53  * @return boolean
    54  *        Toujours à vrai.
    55  */
    56 function cache_taxonomie_ecrire($cache, $service, $action, $tsn, $options) {
    57 
    58         // Création du dossier cache si besoin
    59         sous_repertoire(_DIR_VAR, trim(_TAXONOMIE_CACHE_NOMDIR, '/'));
    60 
    61         // Ecriture du fichier cache
    62         $fichier_cache = cache_taxonomie_nommer($service, $action, $tsn, $options);
    63         ecrire_fichier($fichier_cache, $cache);
    64 
    65         return true;
    66 }
    67 
    68 
    69 /**
    70  * Construit le nom du fichier cache en fonction du service, de l'action, du taxon concernés et
    71  * d'autres critères optionnels.
    72  *
    73  * @package SPIP\TAXONOMIE\CACHE
    74  *
    75  * @param string $service
    76  * @param string $action
    77  * @param int    $tsn
    78  * @param array  $options
    79  *
    80  * @return string
    81  */
    82 function cache_taxonomie_nommer($service, $action, $tsn, $options) {
    83 
    84         // Construction du chemin complet d'un fichier cache
    85         $fichier_cache = _TAXONOMIE_CACHE_DIR
    86                                          . $service
    87                                          . ($action ? '_' . $action : '')
    88                                          . '_' . $tsn;
    89 
    90         // On complète le nom avec les options éventuelles
    91         if ($options) {
    92                 foreach ($options as $_option => $_valeur) {
    93                         if ($_valeur) {
    94                                 $fichier_cache .= '_' . $_valeur;
    95                         }
    96                 }
    97         }
    98 
    99         // On rajoute l'extension texte
    100         $fichier_cache .= '.txt';
    101 
    102         return $fichier_cache;
    103 }
    104 
    105 /**
    106  * Vérifie l'existence du fichier cache pour un taxon, un service et une actions donnés.
    107  * Si le fichier existe la fonction retourne son chemin complet.
    108  *
    109  * @package SPIP\TAXONOMIE\CACHE
    110  *
    111  * @param string $service
    112  * @param string $action
    113  * @param int    $tsn
    114  * @param array  $options
    115  *
    116  * @return string
    117  *        Chemin du fichier cache si il existe ou chaine vide sinon.
    118  */
    119 function cache_taxonomie_existe($service, $action, $tsn, $options = array()) {
    120 
    121         // Contruire le nom du fichier cache
    122         $fichier_cache = cache_taxonomie_nommer($service, $action, $tsn, $options);
    123 
    124         // Vérification de l'existence du fichier:
    125         // - chaine vide si le fichier n'existe pas
    126         // - chemin complet du fichier si il existe
    127         if (!file_exists($fichier_cache)) {
    128                 $fichier_cache = '';
    129         }
    130 
    131         return $fichier_cache;
    1329}
    13310
    … …  
    15229                $fichiers_cache = is_string($caches) ? array($caches) : $caches;
    15330        } else {
    154                 $fichiers_cache = glob(_TAXONOMIE_CACHE_DIR . '*.*');
     31                $fichiers_cache = glob(_DIR_VAR . 'cache-taxonomie/' . '*.*');
    15532        }
    15633

  • _plugins_/taxonomie/trunk/services/itis/itis_api.php

    r113806 r113822  
    44 *
    55 * @package SPIP\TAXONOMIE\SERVICES\ITIS
    6  * @todo    phpdoc : exemples
    76 */
    87if (!defined('_ECRIRE_INC_VERSION')) {
    … …  
    327326 *
    328327 * @api
    329  * @uses cache_taxonomie_existe()
     328 *
     329 * @uses cache_existe()
    330330 * @uses itis_build_url()
    331331 * @uses inc_taxonomie_requeter_dist()
    332  * @uses cache_taxonomie_ecrire()
     332 * @uses cache_ecrire()
     333 * @uses cache_lire()
    333334 *
    334335 * @param int $tsn
    … …  
    436437 *
    437438 * @api
     439 *
     440 * @uses cache_existe()
    438441 * @uses itis_build_url()
    439442 * @uses inc_taxonomie_requeter_dist()
     443 * @uses cache_ecrire()
     444 * @uses cache_lire()
    440445 *
    441446 * @param string $action

  • _plugins_/taxonomie/trunk/services/iucn/iucn_api.php

    r113783 r113822  
    44 *
    55 * @package SPIP\TAXONOMIE\SERVICES\IUCN
    6  * @todo    phpdoc : exemples
    76 */
    87if (!defined('_ECRIRE_INC_VERSION')) {
    … …  
    130129 *
    131130 * @api
    132  * @uses cache_taxonomie_existe()
     131 * @uses cache_existe()
    133132 * @uses itis_build_url()
    134133 * @uses inc_taxonomie_requeter_dist()
    135  * @uses cache_taxonomie_ecrire()
     134 * @uses cache_ecrire()
     135 * @uses cache_lire()
    136136 *
    137137 * @param array  $search

  • _plugins_/taxonomie/trunk/services/wikipedia/wikipedia_api.php

    r113783 r113822  
    44 *
    55 * @package SPIP\TAXONOMIE\SERVICES\WIKIPEDIA
    6  * @todo    phpdoc : exemples
    76 */
    87if (!defined('_ECRIRE_INC_VERSION')) {
    … …  
    5554 *
    5655 * @api
    57  * @uses cache_taxonomie_existe()
    58  * @uses cache_taxonomie_ecrire()
     56 * @uses cache_existe()
    5957 * @uses wikipedia_build_url()
    6058 * @uses inc_taxonomie_requeter()
     59 * @uses cache_ecrire()
     60 * @uses cache_lire()
    6161 *
    6262 * @param array  $search
Note: See TracChangeset for help on using the changeset viewer.