Changeset 92946 in spip-zone


Ignore:
Timestamp:
Nov 15, 2015, 6:13:51 PM (4 years ago)
Author:
eric@…
Message:

Renommage des utilitaires pour les grouper par préfixe sémantique.
Phpdoc et packages.

Location:
_plugins_/taxonomie/trunk
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/taxonomie/trunk/action/inserer_wikipedia.php

    r92936 r92946  
    6060                                //   si besoin
    6161                                include_spip('inc/taxonomer');
    62                                 $maj[$champ] = merger_multi($taxon[$champ], $texte_converti, true);
     62                                $maj[$champ] = taxon_merger_traductions($taxon[$champ], $texte_converti, true);
    6363                                // - l'indicateur d'édition est positionné à oui
    6464                                if ($taxon['edite']) {
  • _plugins_/taxonomie/trunk/formulaires/charger_taxonomie.php

    r92935 r92946  
    2525        // Désactiver l'action vider si aucun règne n'est chargé
    2626        $aucun_regne_charge = true;
    27         $regnes = lister_regnes();
     27        $regnes = explode(':', _TAXONOMIE_REGNES);
    2828        foreach ($regnes as $_regne) {
    2929                $valeurs['_regnes'][$_regne] = '<span class="nom_scientifique">' . $_regne . '</span>, ' . _T("taxonomie:regne_$_regne");
  • _plugins_/taxonomie/trunk/genie/taxonomie_actualiser_itis.php

    r92936 r92946  
    1111
    1212        include_spip('inc/taxonomer');
    13         $regnes = lister_regnes();
     13        $regnes = explode(':', _TAXONOMIE_REGNES);
    1414
    1515        include_spip('services/itis/itis_api');
  • _plugins_/taxonomie/trunk/inc/taxonomer.php

    r92945 r92946  
    5454        define('_TAXONOMIE_RANG_SOUS_FORME', 'subforma');
    5555
    56 // Liste des rangs utilisés du règne au genre compris.
    57 // On utilise par défaut au niveau 2 le terme phylum du règne animal
    58 // (division pour les autres règnes)
     56//
    5957if (!defined('_TAXONOMIE_RANGS_PARENTS_ESPECE'))
     58        /**
     59         * Liste des rangs utilisés du règne au genre compris.
     60         * On utilise par défaut au niveau 2 le terme phylum du règne animal (division pour les autres règnes)
     61         */
    6062        define('_TAXONOMIE_RANGS_PARENTS_ESPECE',
    6163                implode(':', array(
     
    6769                        _TAXONOMIE_RANG_GENRE
    6870                )));
    69 // Liste des rangs utilisés de l'espèce à la sous-forme
    7071if (!defined('_TAXONOMIE_RANGS_ESPECE_ET_FILS'))
     72        /**
     73         * Liste des rangs utilisés de l'espèce à la sous-forme
     74         */
    7175        define('_TAXONOMIE_RANGS_ESPECE_ET_FILS',
    7276                implode(':', array(
     
    7983                        _TAXONOMIE_RANG_SOUS_FORME
    8084                )));
    81 // Liste complète des rangs utilisés par le plugin
    8285if (!defined('_TAXONOMIE_RANGS'))
     86        /**
     87         * Liste complète des rangs utilisés par le plugin
     88         */
    8389        define('_TAXONOMIE_RANGS',
    8490                _TAXONOMIE_RANGS_PARENTS_ESPECE . ':' . _TAXONOMIE_RANGS_ESPECE_ET_FILS);
     
    8692if (!defined('_TAXONOMIE_CACHE_NOMDIR'))
    8793        /**
    88          * Nom du dossier contenant les fichiers caches des éléments de taxonomie */
     94         * Nom du dossier contenant les fichiers caches des éléments de taxonomie
     95         */
    8996        define('_TAXONOMIE_CACHE_NOMDIR', 'cache-taxonomie/');
    9097if (!defined('_TAXONOMIE_CACHE_DIR'))
    9198        /**
    92          * Chemin du dossier contenant les fichiers caches des boussoles */
     99         * Chemin du dossier contenant les fichiers caches des boussoles
     100         */
    93101        define('_TAXONOMIE_CACHE_DIR', _DIR_VAR . _TAXONOMIE_CACHE_NOMDIR);
    94102
     
    98106 * Le service utilise dans ce cas une chaine JSON qui est décodée pour fournir
    99107 * le tableau de sortie. Le flux retourné par le service est systématiquement
    100  * transcodé dans le chrset du site avant d'être décodé.
    101  *
    102  *@param string $url
    103  *              URL complète du service web.
    104  *
    105 *@return array
    106  */
    107 function url2json_data($url, $taille_max=null) {
     108 * transcodé dans le charset du site avant d'être décodé.
     109 *
     110 * @package SPIP\TAXONOMIE\SERVICES
     111 *
     112 * @param string        $url
     113 *              URL complète de la requête au service web concerné.
     114 * @param int|null      $taille_max
     115 *              Taille maximale di flux récupéré suite à la requête.
     116 *              `null` désigne la taille par défaut.
     117 *
     118 * @return array
     119 */
     120function service_requeter_json($url, $taille_max=null) {
    108121        // Acquisition des données spécifiées par l'url
    109122        include_spip('inc/distant');
     
    118131
    119132/**
    120  * Liste dans un tableau les règnes supportés par le plugin, à savoir: animalia,
    121  * plantae et fungi.
    122  * Les règnes sont exprimés avec leur nom scientifique en lettres minuscules.
     133 *
     134 * @package SPIP\TAXONOMIE\OBJET
     135 *
     136 * @param $regne
    123137 *
    124138 * @return array
    125139 */
    126 function lister_regnes() {
    127         return explode(':', _TAXONOMIE_REGNES);
    128 }
    129 
    130 
    131 /**
    132  * @param $regne
    133  *
    134  * @return array
    135  */
    136 function preserver_taxons_edites($regne) {
     140function taxon_preserver_editions($regne) {
    137141        $select = array('tsn', 'nom_commun', 'descriptif');
    138142        $where = array('regne=' . sql_quote($regne), 'edite=' . sql_quote('oui'));
     
    144148
    145149/**
     150 *
     151 * @package SPIP\TAXONOMIE\OBJET
     152 *
    146153 * @param           $nom_charge
    147154 * @param           $nom_edite
     
    150157 * @return string
    151158 */
    152 function merger_multi($nom_charge, $nom_edite, $priorite_edition=true) {
     159function taxon_merger_traductions($nom_charge, $nom_edite, $priorite_edition=true) {
    153160        $source = array();
    154161        $destination = array();
     
    192199
    193200/**
     201 *
     202 * @package SPIP\TAXONOMIE\OBJET
     203 *
    194204 * @param $champ
    195205 *
    196206 * @return string
    197207 */
    198 function traduire_champ_taxon($champ) {
     208function taxon_traduire_champ($champ) {
    199209        $traduction = '';
    200210        if ($champ) {
  • _plugins_/taxonomie/trunk/services/itis/itis_api.php

    r92945 r92946  
    174174 * @api
    175175 * @uses api2url_itis()
    176  * @uses url2json_data()
     176 * @uses service_requeter_json()
    177177 *
    178178 * @param string        $action
     
    201201        // Acquisition des données spécifiées par l'url
    202202        include_spip('inc/taxonomer');
    203         $data = url2json_data($url);
     203        $data = service_requeter_json($url);
    204204
    205205        // Récupération du TSN du taxon recherché
     
    232232 * @api
    233233 * @uses api2url_itis()
    234  * @uses url2json_data()
    235  * @uses extraire_element()
     234 * @uses service_requeter_json()
    236235 *
    237236 * @param int   $tsn
     
    257256        // Acquisition des données spécifiées par l'url
    258257        include_spip('inc/taxonomer');
    259         $data = url2json_data($url);
     258        $data = service_requeter_json($url);
    260259
    261260        // Récupération des informations choisies parmi l'enregistrement reçu à partir de la configuration
     
    291290 * @api
    292291 * @uses api2url_itis()
    293  * @uses url2json_data()
    294  * @uses extraire_element()
     292 * @uses service_requeter_json()
    295293 *
    296294 * @param string        $action
     
    321319        // Acquisition des données spécifiées par l'url
    322320        include_spip('inc/taxonomer');
    323         $data = url2json_data($url);
     321        $data = service_requeter_json($url);
    324322
    325323        // On vérifie que le tableau est complet sinon on retourne un tableau vide
     
    369367 * @api
    370368 * @uses api2url_itis()
    371  * @uses url2json_data()
     369 * @uses service_requeter_json()
    372370 *
    373371 * @param $language
     
    390388        include_spip('inc/taxonomer');
    391389        include_spip('inc/distant');
    392         $data = url2json_data($url, _INC_DISTANT_MAX_SIZE*7);
     390        $data = service_requeter_json($url, _INC_DISTANT_MAX_SIZE*7);
    393391
    394392        $api = $itis_webservice['vernacular']['vernacularlanguage'];
     
    623621 *
    624622 * @api
    625  * @uses lister_regnes()
    626623 *
    627624 * @return array
     
    635632
    636633        include_spip('inc/taxonomer');
    637         $kingdoms = lister_regnes();
     634        $kingdoms = explode(':', _TAXONOMIE_REGNES);
    638635
    639636        foreach ($kingdoms as $_kingdom) {
  • _plugins_/taxonomie/trunk/services/wikipedia/wikipedia_api.php

    r92945 r92946  
    5454 * @uses cache_taxonomie_ecrire()
    5555 * @uses api2url_wikipedia()
    56  * @uses url2json_data()
     56 * @uses service_requeter_json()
    5757 *
    5858 * @param int           $tsn
     
    9090                // Acquisition des données spécifiées par l'url
    9191                include_spip('inc/taxonomer');
    92                 $data = url2json_data($url);
     92                $data = service_requeter_json($url);
    9393
    9494                // Récupération de la section demandée.
     
    170170        // La liste des champs concernés (a priori le descriptif)
    171171        include_spip('inc/taxonomer');
    172         $champs = implode(', ', array_map('traduire_champ_taxon', $informations['champs']));
     172        $champs = implode(', ', array_map('taxon_traduire_champ', $informations['champs']));
    173173
    174174        // On établit la citation
  • _plugins_/taxonomie/trunk/taxonomie_administrations.php

    r92934 r92946  
    5757        // Effacer la meta de chaque règne chargé. On boucle sur tous les règnes
    5858        include_spip('inc/taxonomer');
    59         foreach (lister_regnes() as $_regne) {
     59        foreach (explode(':', _TAXONOMIE_REGNES) as $_regne) {
    6060                effacer_meta("taxonomie_${_regne}");
    6161        }
  • _plugins_/taxonomie/trunk/taxonomie_fonctions.php

    r92941 r92946  
    1717 * @filtre
    1818 * @uses taxonomie_regne_existe()
    19  * @uses preserver_taxons_edites()
     19 * @uses taxon_preserver_editions()
    2020 * @uses taxonomie_vider_regne()
    2121 * @uses itis_read_hierarchy()
     
    4242                // Sauvegarde des taxons ayant été modifiés manuellement suite à leur création automatique.
    4343                include_spip('inc/taxonomer');
    44                 $taxons_edites = preserver_taxons_edites($regne);
     44                $taxons_edites = taxon_preserver_editions($regne);
    4545
    4646                // Vider le règne avant de le recharger
     
    9696                                AND (array_key_exists($tsn, $taxons))) {
    9797                                        $taxons[$tsn]['descriptif'] = $_taxon_edite['descriptif'];
    98                                         $taxons[$tsn]['nom_commun'] = merger_multi(
     98                                        $taxons[$tsn]['nom_commun'] = taxon_merger_traductions(
    9999                                                                                                        $taxons[$tsn]['nom_commun'],
    100100                                                                                                        $_taxon_edite['nom_commun'],
Note: See TracChangeset for help on using the changeset viewer.