Changeset 92941 in spip-zone


Ignore:
Timestamp:
Nov 15, 2015, 10:09:40 AM (4 years ago)
Author:
eric@…
Message:

Phpdoc sur les utilitaires.

Location:
_plugins_/taxonomie/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/taxonomie/trunk/inc/taxonomer.php

    r92933 r92941  
    11<?php
    22/**
    3  * Ce fichier contient un ensembles d'utilitaires et de constantes manipulés par les fonctions et api du plugin.
     3 * Ce fichier contient l'ensemble des constantes et des utilitaires nécessaires au fonctionnement du plugin.
    44 *
    55 * @package SPIP\TAXONOMIE\OUTILS
     
    1515        define('_TAXONOMIE_REGNE_FONGIQUE', 'fungi');
    1616
    17 if (!defined('_TAXONOMIE_LISTE_REGNES'))
    18         define('_TAXONOMIE_LISTE_REGNES',
     17if (!defined('_TAXONOMIE_REGNES'))
     18        define('_TAXONOMIE_REGNES',
    1919                implode(':', array(
    2020                        _TAXONOMIE_REGNE_ANIMAL,
     
    125125 */
    126126function lister_regnes() {
    127         return explode(':', _TAXONOMIE_LISTE_REGNES);
    128 }
    129 
    130 
     127        return explode(':', _TAXONOMIE_REGNES);
     128}
     129
     130
     131/**
     132 * @param $regne
     133 *
     134 * @return array
     135 */
    131136function preserver_taxons_edites($regne) {
    132137        $select = array('tsn', 'nom_commun', 'descriptif');
     
    138143
    139144
     145/**
     146 * @param           $nom_charge
     147 * @param           $nom_edite
     148 * @param bool|true $priorite_edition
     149 *
     150 * @return string
     151 */
    140152function merger_multi($nom_charge, $nom_edite, $priorite_edition=true) {
    141153        $source = array();
     
    179191
    180192
     193/**
     194 * @param $champ
     195 *
     196 * @return string
     197 */
    181198function traduire_champ_taxon($champ) {
    182199        $traduction = '';
     
    188205
    189206
     207/**
     208 * @param $tableau
     209 * @param $cles
     210 *
     211 * @return null
     212 */
    190213function extraire_element($tableau, $cles) {
    191     $erreur = false;
    192     $element = $tableau;
     214        $erreur = false;
     215        $element = $tableau;
    193216        if ($cles) {
    194217                $cles = is_string($cles) ? array($cles) : $cles;
    195218                foreach ($cles as $_cle) {
    196                 if (isset($element[$_cle])) {
    197           $element = $element[$_cle];
    198                 }
    199                 else {
    200                         $erreur = true;
    201                         break;
    202                 }
    203         }
    204         }
    205     return ($erreur ? null : $element);
    206 }
    207 
    208 /**
    209  * Ecriture d'un contenu issu d'un service web taxonomique dans un fichier texte afin d'optimiser le nombre
    210  * de requête adressée au service.
     219                if (isset($element[$_cle])) {
     220                  $element = $element[$_cle];
     221                }
     222                else {
     223                        $erreur = true;
     224                        break;
     225                }
     226        }
     227        }
     228        return ($erreur ? null : $element);
     229}
     230
     231/**
     232 * Ecrit le contenu issu d'un service taxonomique dans un fichier texte afin d'optimiser le nombre
     233 * de requêtes adressées au service.
    211234 *
    212235 * @package SPIP\TAXONOMIE\CACHE
     
    217240 * @param string    $service
    218241 * @param int       $tsn
    219  * @param string    $code_langue
     242 * @param string    $spip_langue
    220243 * @param string    $action
    221244 *
     
    223246 *              Toujours à vrai.
    224247 */
    225 function ecrire_cache_taxonomie($cache, $service, $tsn, $code_langue='', $action='') {
     248function ecrire_cache_taxonomie($cache, $service, $tsn, $spip_langue='', $action='') {
    226249        // Création du dossier cache si besoin
    227250        sous_repertoire(_DIR_VAR, trim(_TAXONOMIE_CACHE_NOMDIR, '/'));
    228251
    229252        // Ecriture du fichier cache
    230         $fichier_cache = nommer_cache_taxonomie($service, $tsn, $code_langue, $action);
     253        $fichier_cache = nommer_cache_taxonomie($service, $tsn, $spip_langue, $action);
    231254        ecrire_fichier($fichier_cache, $cache);
    232255
     
    236259
    237260/**
     261 * Construit le nom du fichier cache en fonction du service, du taxon concernés et
     262 * d'autres critères optionnels.
    238263 *
    239264 * @package SPIP\TAXONOMIE\CACHE
    240265 *
    241  * @param $service
    242  * @param $tsn
    243  * @param string $code_langue
    244  * @param string $action
     266 * @param string    $service
     267 * @param int       $tsn
     268 * @param string    $spip_langue
     269 * @param string    $action
     270 *
    245271 * @return string
    246272 */
    247 function nommer_cache_taxonomie($service, $tsn, $code_langue='', $action='') {
     273function nommer_cache_taxonomie($service, $tsn, $spip_langue='', $action='') {
    248274        // Construction du chemin complet d'un fichier cache
    249275        $fichier_cache = _TAXONOMIE_CACHE_DIR
     
    251277                . ($action ? '_' . $action : '')
    252278                . '_' . $tsn
    253                 . ($code_langue ? '_' . $code_langue : '')
     279                . ($spip_langue ? '_' . $spip_langue : '')
    254280                . '.txt';
    255281
     
    258284
    259285/**
    260  * Vérifie l'existence du fichier cache pour un taxon et un service donnés. Si le fichier existe
    261  * la fonction retourne son chemin complet.
     286 * Vérifie l'existence du fichier cache pour un taxon et un service donnés.
     287 * Si le fichier existe la fonction retourne son chemin complet.
    262288 *
    263289 * @package SPIP\TAXONOMIE\CACHE
     
    265291 * @param string    $service
    266292 * @param int       $tsn
    267  * @param string    $code_langue
     293 * @param string    $spip_langue
    268294 * @param string    $action
    269295 *
     
    271297 *              Chemin du fichier cache si il existe ou chaine vide sinon.
    272298 */
    273 function cache_taxonomie_existe($service, $tsn, $code_langue='', $action='') {
     299function cache_taxonomie_existe($service, $tsn, $spip_langue='', $action='') {
    274300        // Contruire le nom du fichier cache
    275         $fichier_cache = nommer_cache_taxonomie($service, $tsn, $code_langue, $action);
     301        $fichier_cache = nommer_cache_taxonomie($service, $tsn, $spip_langue, $action);
    276302
    277303        // Vérification de l'existence du fichier:
     
    286312
    287313/**
    288  * Supprime tous les fichiers caches.
     314 * Supprime tout ou partie des fichiers cache taxonomiques.
    289315 *
    290316 * @package SPIP\TAXONOMIE\CACHE
    291317 *
     318 * @param array|string  $caches
     319 *              Liste des fichiers à supprimer ou vide si tous les fichiers cache doivent être supprimer.
     320 *              Il est possible de passer un seul fichier comme une chaine et pas un tableau à un élément.
     321 *
    292322 * @return boolean
    293  *              Toujours à vrai.
    294  */
    295 function cache_taxonomie_supprimer(){
     323 *              Toujours à `true`.
     324 */
     325function cache_taxonomie_supprimer($caches=array()){
    296326        include_spip('inc/flock');
    297327
    298         if ($fichiers_cache = glob(_TAXONOMIE_CACHE_DIR . "*.*")) {
     328        if ($caches) {
     329                $fichiers_cache = is_string($caches) ? array($caches) : $caches;
     330        } else {
     331                $fichiers_cache = glob(_TAXONOMIE_CACHE_DIR . "*.*");
     332        }
     333
     334        if ($fichiers_cache) {
    299335                foreach ($fichiers_cache as $_fichier) {
    300336                        supprimer_fichier($_fichier);
  • _plugins_/taxonomie/trunk/taxonomie_fonctions.php

    r92939 r92941  
    11<?php
    22/**
    3  * Ce fichier contient l'ensemble fonctions implémentant l'API du plugin Taxonomie.
     3 * Ce fichier contient l'ensemble des fonctions implémentant l'API du plugin Taxonomie.
    44 *
    55 * @package SPIP\TAXONOMIE\API
     
    226226 *              Id du taxon pour lequel il faut fournir l'ascendance.
    227227 * @param int           $tsn_parent
    228  *      TSN du parent correspondant au taxon id_taxon. Ce paramètre permet d'optimiser le traitement
     228 *              TSN du parent correspondant au taxon id_taxon. Ce paramètre permet d'optimiser le traitement
    229229 *              mais n'est pas obligatoire. Si il n'est pas connu lors de l'appel il faut passer `null`.
    230230 * @param string        $ordre
Note: See TracChangeset for help on using the changeset viewer.