Changeset 93059 in spip-zone


Ignore:
Timestamp:
Nov 21, 2015, 12:24:02 PM (5 years ago)
Author:
eric@…
Message:

Finalisation d'un premier jet complet du phpdoc.

Location:
_plugins_/taxonomie/trunk
Files:
7 edited

Legend:

Unmodified
Added
Removed

  • _plugins_/taxonomie/trunk/base/taxonomie_declarations.php

    r92934 r93059  
    11<?php
    22/**
    3  * Déclarations relatives à la base de données
     3 * Déclarations relatives à la base de données.
    44 *
    5  * @plugin     Taxonomie
    6  * @copyright  2014
    7  * @author     Eric
    8  * @licence    GNU/GPL
    9  * @package    SPIP\TAXONOMIE\ADMINISTRATION
     5 * @package SPIP\TAXONOMIE\ADMINISTRATION
    106 */
    117
    … …  
    1410
    1511/**
    16  * Déclaration des alias de tables et filtres automatiques de champs
     12 * Déclaration des alias de tables et des filtres automatiques de champs.
    1713 *
    1814 * @pipeline declarer_tables_interfaces
     15 *
    1916 * @param array $interfaces
    20  *     Déclarations d'interface pour le compilateur
     17 *              Déclarations d'interface pour le compilateur.
     18 *
    2119 * @return array
    22  *     Déclarations d'interface pour le compilateur
     20 *              Déclarations d'interface pour le compilateur mises à jour.
    2321 */
    2422function taxonomie_declarer_tables_interfaces($interfaces) {
    … …  
    3129
    3230/**
    33  * Déclaration des objets éditoriaux
     31 * Déclaration des objets éditoriaux du plugin. Le plugin ajoute l'objet taxon au travers de la
     32 * seule table `spip_taxons`.
     33 *
     34 * L'objet taxon est défini comme une arborescence de taxons du règne au genre.
     35 * Les taxons à partir de l'espèce ne font pas partie de cette table. Les champs principaux sont les
     36 * suivants :
     37 *              - `nom_scientifique` est le nom en latin. Il est unique pour un rang taxonomique donné.
     38 *              - `rang` taxonomique est une valeur parmi `kingdom`, `phylum`, `class`, `order`, `family` et `genus`.
     39 *              - `nom_commun` est le nom vulgaire, si possible normalisé par une commission officielle. Il peut coincider ou pas
     40 *              avec le nom vernaculaire.
     41 *              - `auteur` est une information composée d'un ou plusieurs noms complétés par une date (ex : Linneus, 1798).
     42 *              - `tsn` est l'identifiant numérique unique du taxon dans la base taxonomique ITIS.
     43 *              - `tsn_parent` permet de créer l'arborescence taxonomique du règne conformément à l'organisation de la base ITIS.
    3444 *
    3545 * @pipeline declarer_tables_objets_sql
     46 *
    3647 * @param array $tables
    37  *     Description des tables
     48 *              Description des tables de la base.
     49 *
    3850 * @return array
    39  *     Description complétée des tables
     51 *              Description des tables de la base complétée par celles du plugin.
    4052 */
    4153function taxonomie_declarer_tables_objets_sql($tables) {
    4254
    4355        /**
    44          * Déclaration de l'objet taxon utilisé pour matérialiser une arborescence de taxons
    45          * du règne au genre. Les taxons à partir de l'espèce ne font pas partie de cette
    46          * table.
    47          *
    48          * Le nom_scientifique est le nom en latin. Il est unique pour un rang taxonomique donné.
    49          * Le rang taxonomique est une valeur parmi règne, phylum, classe, ordre, famille et genre.
    50          * Le nom_commun est le nom vulgaire, si possible normalisé par une commission officielle. Il peut coincider ou pas
    51          * avec le nom vernaculaire.
    52          * L'auteur est une information composée d'un ou plusieurs noms complétés par une date (Linneus, 1798).
    53          * tsn est l'identifiant numérique unique du taxon dans la base taxonomique ITIS.
    54          * tsn_parent permet de créer l'arborescence taxonomique du règne conformément à l'organisation de la base ITIS
    5556         */
    5657        $tables['spip_taxons'] = array(

  • _plugins_/taxonomie/trunk/formulaires/editer_taxon.php

    r93037 r93059  
    33 * Gestion du formulaire d'édition de l'objet taxon
    44 *
    5  * @package    SPIP\TAXONOMIE\OBJET
     5 * @package SPIP\TAXONOMIE\OBJET
    66 */
    77
    … …  
    1212
    1313/**
    14  * Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
     14 * Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité.
    1515 *
    16  * @param int|string $id_taxon
    17  *     Identifiant du taxon. 'new' pour un nouveau taxon.
    18  * @param string $retour
    19  *     URL de redirection après le traitement
    20  * @param int $lier_trad
    21  *     Identifiant éventuel d'un taxon source d'une traduction
    22  * @param string $config_fonc
    23  *     Nom de la fonction ajoutant des configurations particulières au formulaire
    24  * @param array $row
    25  *     Valeurs de la ligne SQL du taxon, si connu
    26  * @param string $hidden
    27  *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     16 * @param int|string    $id_taxon
     17 *              Identifiant du taxon. 'new' pour un nouveau taxon.
     18 * @param string                $retour
     19 *              URL de redirection après le traitement
     20 * @param int                   $lier_trad
     21 *              Identifiant éventuel d'un taxon source d'une traduction
     22 * @param string                $config_fonc
     23 *              Nom de la fonction ajoutant des configurations particulières au formulaire
     24 * @param array                 $row
     25 *              Valeurs de la ligne SQL du taxon, si connu
     26 * @param string                $hidden
     27 *              Contenu HTML ajouté en même temps que les champs cachés du formulaire.
    2828 *
    2929 * @return string
    30  *     Hash du formulaire
     30 *              Hash du formulaire
    3131 */
    3232function formulaires_editer_taxon_identifier_dist($id_taxon='new', $retour='', $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     33
    3334        return serialize(array(intval($id_taxon)));
    3435}
    3536
    3637/**
    37  * Chargement du formulaire d'édition de taxon
    38  *
    39  * Déclarer les champs postés et y intégrer les valeurs par défaut
     38 * Chargement du formulaire d'édition de taxon.
     39 * Déclarer les champs postés et y intégrer les valeurs par défaut.
    4040 *
    4141 * @uses formulaires_editer_objet_charger()
    4242 *
    43  * @param int|string $id_taxon
    44  *     Identifiant du taxon. 'new' pour un nouveau taxon.
    45  * @param string $retour
    46  *     URL de redirection après le traitement
    47  * @param int $lier_trad
    48  *     Identifiant éventuel d'un taxon source d'une traduction
    49  * @param string $config_fonc
    50  *     Nom de la fonction ajoutant des configurations particulières au formulaire
    51  * @param array $row
    52  *     Valeurs de la ligne SQL du taxon, si connu
    53  * @param string $hidden
    54  *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     43 * @param int|string    $id_taxon
     44 *              Identifiant du taxon. 'new' pour un nouveau taxon.
     45 * @param string                $retour
     46 *              URL de redirection après le traitement
     47 * @param int                   $lier_trad
     48 *              Identifiant éventuel d'un taxon source d'une traduction
     49 * @param string                $config_fonc
     50 *              Nom de la fonction ajoutant des configurations particulières au formulaire
     51 * @param array                 $row
     52 *              Valeurs de la ligne SQL du taxon, si connu
     53 * @param string                $hidden
     54 *              Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     55 *
    5556 * @return array
    56  *     Environnement du formulaire
     57 *              Environnement du formulaire.
    5758 */
    5859function formulaires_editer_taxon_charger_dist($id_taxon='new', $retour='', $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
    5960        $valeurs = formulaires_editer_objet_charger('taxon',$id_taxon,'',$lier_trad,$retour,$config_fonc,$row,$hidden);
     61
    6062        return $valeurs;
    6163}
    6264
    6365/**
    64  * Vérifications du formulaire d'édition de taxon
    65  *
    66  * Vérifier les champs postés et signaler d'éventuelles erreurs
     66 * Vérifications du formulaire d'édition de taxon.
     67 * Vérifier les champs postés et signaler d'éventuelles erreurs.
    6768 *
    6869 * @uses formulaires_editer_objet_verifier()
    6970 *
    70  * @param int|string $id_taxon
    71  *     Identifiant du taxon. 'new' pour un nouveau taxon.
    72  * @param string $retour
    73  *     URL de redirection après le traitement
    74  * @param int $lier_trad
    75  *     Identifiant éventuel d'un taxon source d'une traduction
    76  * @param string $config_fonc
    77  *     Nom de la fonction ajoutant des configurations particulières au formulaire
    78  * @param array $row
    79  *     Valeurs de la ligne SQL du taxon, si connu
    80  * @param string $hidden
    81  *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     71 * @param int|string    $id_taxon
     72 *              Identifiant du taxon. 'new' pour un nouveau taxon.
     73 * @param string                $retour
     74 *              URL de redirection après le traitement
     75 * @param int                   $lier_trad
     76 *              Identifiant éventuel d'un taxon source d'une traduction
     77 * @param string                $config_fonc
     78 *              Nom de la fonction ajoutant des configurations particulières au formulaire
     79 * @param array                 $row
     80 *              Valeurs de la ligne SQL du taxon, si connu
     81 * @param string                $hidden
     82 *              Contenu HTML ajouté en même temps que les champs cachés du formulaire.
    8283 *
    8384 * @return array
    84  *     Tableau des erreurs
     85 *              Tableau des erreurs indexé par le nom du champ en erreur.
    8586 */
    8687function formulaires_editer_taxon_verifier_dist($id_taxon='new', $retour='', $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
    … …  
    9192
    9293/**
    93  * Traitement du formulaire d'édition de taxon
    94  *
    95  * Traiter les champs postés
     94 * Traitement du formulaire d'édition de taxon.
     95 * Traiter les champs postés.
    9696 *
    9797 * @uses formulaires_editer_objet_traiter()
    9898 *
    99  * @param int|string $id_taxon
    100  *     Identifiant du taxon. 'new' pour un nouveau taxon.
    101  * @param string $retour
    102  *     URL de redirection après le traitement
    103  * @param int $lier_trad
    104  *     Identifiant éventuel d'un taxon source d'une traduction
    105  * @param string $config_fonc
    106  *     Nom de la fonction ajoutant des configurations particulières au formulaire
    107  * @param array $row
    108  *     Valeurs de la ligne SQL du taxon, si connu
    109  * @param string $hidden
    110  *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     99 * @param int|string    $id_taxon
     100 *              Identifiant du taxon. 'new' pour un nouveau taxon.
     101 * @param string                $retour
     102 *              URL de redirection après le traitement
     103 * @param int                   $lier_trad
     104 *              Identifiant éventuel d'un taxon source d'une traduction
     105 * @param string                $config_fonc
     106 *              Nom de la fonction ajoutant des configurations particulières au formulaire
     107 * @param array                 $row
     108 *              Valeurs de la ligne SQL du taxon, si connu
     109 * @param string                $hidden
     110 *              Contenu HTML ajouté en même temps que les champs cachés du formulaire.
    111111 *
    112112 * @return array
    113  *     Retours des traitements
     113 *              Retours des traitements.
    114114 */
    115115function formulaires_editer_taxon_traiter_dist($id_taxon='new', $retour='', $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     116
    116117        return formulaires_editer_objet_traiter('taxon',$id_taxon,'',$lier_trad,$retour,$config_fonc,$row,$hidden);
    117118}

  • _plugins_/taxonomie/trunk/genie/taxonomie_actualiser_itis.php

    r93037 r93059  
    11<?php
    22/**
    3  * CRON de mise à jour des taxons en fonction des fichiers de chaque règne embarqués.
     3 * CRON de mise à jour des taxons en fonction des fichiers de chaque règne embarqué.
    44 *
    55 * @package    SPIP\TAXONOMIE\SERVICES\ITIS

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

    r92946 r93059  
    44 *
    55 * @package SPIP\TAXONOMIE\SERVICES\ITIS
    6  * @todo phpdoc : décider sur les globales
    76 * @todo phpdoc : exemples
    87 */

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

    r92946 r93059  
    44 *
    55 * @package SPIP\TAXONOMIE\SERVICES\WIKIPEDIA
    6  * @todo phpdoc : décider sur les globales
    76 * @todo phpdoc : exemples
    87 */

  • _plugins_/taxonomie/trunk/taxonomie_administrations.php

    r92981 r93059  
    11<?php
    22/**
    3  * Fichier gérant l'installation et désinstallation du plugin Taxonomie
     3 * Fichier gérant l'installation et la désinstallation du plugin Taxonomie
    44 *
    5  * @plugin     Taxonomie
    6  * @copyright  2014
    7  * @author     Eric
    8  * @licence    GNU/GPL
    95 * @package    SPIP\TAXONOMIE\ADMINISTRATION
    106 */
    … …  
    1511/**
    1612 * Fonction d'installation et de mise à jour du plugin.
    17  * Le schéma du plugin est composé d'une table spip_taxons et d'une
    18  * configuration.
     13 * Le schéma du plugin est composé d'une table `spip_taxons` et d'une configuration.
    1914 *
    20  * @param string $nom_meta_base_version
    21  *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
    22  * @param string $version_cible
    23  *     Version du schéma de données (déclaré dans paquet.xml)
     15 * @param string        $nom_meta_base_version
     16 *              Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
     17 * @param string        $version_cible
     18 *              Version du schéma de données (déclaré dans paquet.xml)
     19 *
    2420 * @return void
    2521**/
    … …  
    4238 * Fonction de désinstallation du plugin.
    4339 *
    44  * @param string $nom_meta_base_version
    45  *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
     40 * @param string        $nom_meta_base_version
     41 *              Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP.
     42 *
    4643 * @return void
    4744**/

  • _plugins_/taxonomie/trunk/taxonomie_autorisations.php

    r92933 r93059  
    33 * Définit les autorisations du plugin Taxonomie
    44 *
    5  * @plugin     Taxonomie
    6  * @copyright  2014
    7  * @author     _Eric_
    8  * @licence    GNU/GPL
    95 * @package    SPIP\TAXONOMIE\AUTORISATIONS
    106 */
    … …  
    1410
    1511/**
    16  * Fonction d'appel pour le pipeline
    17  * @pipeline autoriser */
     12 * Fonction d'appel pour le pipeline.
     13 *
     14 * @pipeline autoriser
     15**/
    1816function taxonomie_autoriser(){}
    1917
    … …  
    2321
    2422/**
    25  * Autorisation de créer (taxon)
     23 * Autorisation de créer un taxon : il faut être au moins rédacteur.
    2624 *
    27  * @param  string $faire Action demandée
    28  * @param  string $type  Type d'objet sur lequel appliquer l'action
    29  * @param  int    $id    Identifiant de l'objet
    30  * @param  array  $qui   Description de l'auteur demandant l'autorisation
    31  * @param  array  $opt   Options de cette autorisation
    32  * @return bool          true s'il a le droit, false sinon
     25 * @param string        $faire
     26 *              Action demandée.
     27 * @param string        $type
     28 *              Type d'objet sur lequel appliquer l'action.
     29 * @param int           $id
     30 *              Identifiant de l'objet.
     31 * @param array         $qui
     32 *              Description de l'auteur demandant l'autorisation.
     33 * @param array         $opt
     34 *              Options de cette autorisation.
     35 *
     36 * @return bool
     37 *              `true` si l'autoriation est donnée, `false` sinon
    3338**/
    3439function autoriser_taxon_creer_dist($faire, $type, $id, $qui, $opt) {
    … …  
    3742
    3843/**
    39  * Autorisation de voir (taxon)
     44 * Autorisation de voir un taxon : tout le monde est autorisé.
    4045 *
    41  * @param  string $faire Action demandée
    42  * @param  string $type  Type d'objet sur lequel appliquer l'action
    43  * @param  int    $id    Identifiant de l'objet
    44  * @param  array  $qui   Description de l'auteur demandant l'autorisation
    45  * @param  array  $opt   Options de cette autorisation
    46  * @return bool          true s'il a le droit, false sinon
     46 * @param string        $faire
     47 *              Action demandée.
     48 * @param string        $type
     49 *              Type d'objet sur lequel appliquer l'action.
     50 * @param int           $id
     51 *              Identifiant de l'objet.
     52 * @param array         $qui
     53 *              Description de l'auteur demandant l'autorisation.
     54 * @param array         $opt
     55 *              Options de cette autorisation.
     56 *
     57 * @return bool
     58 *              `true` si l'autoriation est donnée, `false` sinon
    4759**/
    4860function autoriser_taxon_voir_dist($faire, $type, $id, $qui, $opt) {
    … …  
    5163
    5264/**
    53  * Autorisation de modifier (taxon)
     65 * Autorisation de modifier un taxon : il faut pouvoir en créer un.
    5466 *
    55  * @param  string $faire Action demandée
    56  * @param  string $type  Type d'objet sur lequel appliquer l'action
    57  * @param  int    $id    Identifiant de l'objet
    58  * @param  array  $qui   Description de l'auteur demandant l'autorisation
    59  * @param  array  $opt   Options de cette autorisation
    60  * @return bool          true s'il a le droit, false sinon
     67 * @param string        $faire
     68 *              Action demandée.
     69 * @param string        $type
     70 *              Type d'objet sur lequel appliquer l'action.
     71 * @param int           $id
     72 *              Identifiant de l'objet.
     73 * @param array         $qui
     74 *              Description de l'auteur demandant l'autorisation.
     75 * @param array         $opt
     76 *              Options de cette autorisation.
     77 *
     78 * @return bool
     79 *              `true` si l'autoriation est donnée, `false` sinon
    6180**/
    6281function autoriser_taxon_modifier_dist($faire, $type, $id, $qui, $opt) {
    63         return in_array($qui['statut'], array('0minirezo', '1comite'));
     82        return autoriser('creer', 'taxon', $id, $qui, $opt);
    6483}
    6584
    6685/**
    67  * Autorisation de supprimer (taxon)
     86 * Autorisation de supprimer un taxon : aucun taxon ne peut être supprimé individuellement.
    6887 *
    69  * @param  string $faire Action demandée
    70  * @param  string $type  Type d'objet sur lequel appliquer l'action
    71  * @param  int    $id    Identifiant de l'objet
    72  * @param  array  $qui   Description de l'auteur demandant l'autorisation
    73  * @param  array  $opt   Options de cette autorisation
    74  * @return bool          true s'il a le droit, false sinon
     88 * @param string        $faire
     89 *              Action demandée.
     90 * @param string        $type
     91 *              Type d'objet sur lequel appliquer l'action.
     92 * @param int           $id
     93 *              Identifiant de l'objet.
     94 * @param array         $qui
     95 *              Description de l'auteur demandant l'autorisation.
     96 * @param array         $opt
     97 *              Options de cette autorisation.
     98 *
     99 * @return bool
     100 *              `true` si l'autoriation est donnée, `false` sinon
    75101**/
    76102function autoriser_taxon_supprimer_dist($faire, $type, $id, $qui, $opt) {
    77         return $qui['statut'] == '0minirezo' AND !$qui['restreint'];
     103        return false;
    78104}
     105
    79106/**
    80  * Autorisation d'iconifier (taxon)
     107 * Autorisation d'iconifier un taxon : aucun taxon ne peut être iconifié actuellement.
    81108 *
    82  * @param  string $faire Action demandée
    83  * @param  string $type  Type d'objet sur lequel appliquer l'action
    84  * @param  int    $id    Identifiant de l'objet
    85  * @param  array  $qui   Description de l'auteur demandant l'autorisation
    86  * @param  array  $opt   Options de cette autorisation
    87  * @return bool          true s'il a le droit, false sinon
     109 * @param string        $faire
     110 *              Action demandée.
     111 * @param string        $type
     112 *              Type d'objet sur lequel appliquer l'action.
     113 * @param int           $id
     114 *              Identifiant de l'objet.
     115 * @param array         $qui
     116 *              Description de l'auteur demandant l'autorisation.
     117 * @param array         $opt
     118 *              Options de cette autorisation.
     119 *
     120 * @return bool
     121 *              `true` si l'autoriation est donnée, `false` sinon
    88122**/
    89123function autoriser_taxon_iconifier_dist($faire, $type, $id, $qui, $opt) {
    … …  
    91125}
    92126
    93 
    94127?>
Note: See TracChangeset for help on using the changeset viewer.