Changeset 106533 in spip-zone


Ignore:
Timestamp:
Oct 8, 2017, 10:00:20 AM (2 years ago)
Author:
eric@…
Message:

Suite de PSR et PHPDoc

Location:
_plugins_/n-core/trunk
Files:
1 deleted
4 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/n-core/trunk/inc/ncore_cache.php

    r105931 r106533  
    6262 * @uses lire_fichier_securise()
    6363 *
    64  * @param string        $plugin
    65  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    66  *      ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    67  * @param string        $nom_cache
    68  *              Nom et extension du fichier cache.
     64 * @param string $plugin
     65 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     66 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     67 * @param string $nom_cache
     68 *        Nom et extension du fichier cache.
    6969 *
    7070 * @return array
    71  *              Contenu du fichier sous la forme d'un tableau éventuellement vide.
     71 *        Contenu du fichier sous la forme d'un tableau éventuellement vide.
    7272 */
    7373function cache_lire($plugin, $nom_cache) {
     
    9494 * @uses ecrire_fichier_securise()
    9595 *
    96  * @param string        $plugin
    97  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    98  *      ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    99  * @param string        $nom_cache
    100  *              Nom et extension du fichier cache.
    101  * @param array     $contenu_cache
    102  *              Contenu sous forme de tableau à stocker dans un fichier cache après sérialisation.
     96 * @param string $plugin
     97 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     98 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     99 * @param string $nom_cache
     100 *        Nom et extension du fichier cache.
     101 * @param array  $contenu_cache
     102 *        Contenu sous forme de tableau à stocker dans un fichier cache après sérialisation.
    103103 *
    104104 * @return void
     
    130130 * @uses supprimer_fichier()
    131131 *
    132  * @param string        $plugin
    133  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    134  *      ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    135  * @param string        $nom_cache
    136  *              Nom et extension du fichier cache.
     132 * @param string $plugin
     133 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     134 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     135 * @param string $nom_cache
     136 *        Nom et extension du fichier cache.
    137137 *
    138138 * @return void
  • _plugins_/n-core/trunk/inc/ncore_type_noisette.php

    r106073 r106533  
    2121 * @uses ncore_type_noisette_stocker()
    2222 *
    23  * @param string        $plugin
    24  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    25  *      ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    26  * @param string        $dossier
    27  *              Chemin relatif (avec un `/` final) dans lequel chercher les fichiers YAML de description des noisettes.
    28  *              Par défaut, les noisettes seront recherchées dans le dossier `noisettes/`.
    29  * @param bool          $recharger
    30  *      Si `true` force le rechargement de toutes les types de noisettes, sinon le chargement se base sur le
    31  *              md5 des fichiers YAML. Par défaut vaut `false`.
    32  * @param string        $stockage
    33  *      Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
    34  *      ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
    35  *              fournissant le service de stockage souhaité.
     23 * @param string $plugin
     24 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     25 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     26 * @param string $dossier
     27 *        Chemin relatif (avec un `/` final) dans lequel chercher les fichiers YAML de description des noisettes.
     28 *        Par défaut, les noisettes seront recherchées dans le dossier `noisettes/`.
     29 * @param bool   $recharger
     30 *        Si `true` force le rechargement de toutes les types de noisettes, sinon le chargement se base sur le
     31 *        md5 des fichiers YAML. Par défaut vaut `false`.
     32 * @param string $stockage
     33 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
     34 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
     35 *        fournissant le service de stockage souhaité.
    3636 *
    3737 * @return bool
    38  *              `false` si une erreur s'est produite, `true` sinon.
     38 *        `false` si une erreur s'est produite, `true` sinon.
    3939 */
    4040function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = false, $stockage = '') {
     
    7777                        // -- on y inclut le plugin appelant et la signature
    7878                        $description_defaut = array(
    79                                 'noisette'       => $type_noisette,
    80                                 'nom'            => $type_noisette,
    81                                 'description'    => '',
    82                                 'icon'           => 'noisette-24.png',
    83                                 'necessite'      => array(),
    84                                 'contexte'       => array(),
    85                                 'ajax'           => 'defaut',
    86                                 'inclusion'      => 'statique',
    87                                 'parametres'     => array(),
    88                                 'plugin'         => $plugin,
    89                                 'signature'      => '',
     79                                'noisette'    => $type_noisette,
     80                                'nom'         => $type_noisette,
     81                                'description' => '',
     82                                'icon'        => 'noisette-24.png',
     83                                'necessite'   => array(),
     84                                'contexte'    => array(),
     85                                'ajax'        => 'defaut',
     86                                'inclusion'   => 'statique',
     87                                'parametres'  => array(),
     88                                'plugin'      => $plugin,
     89                                'signature'   => '',
    9090                        );
    9191
     
    9797                                $description = yaml_charger_inclusions(yaml_decode_file($_chemin));
    9898
    99                                         // Traitements des champs pouvant être soit une chaine soit un tableau
     99                                // Traitements des champs pouvant être soit une chaine soit un tableau
    100100                                if (!empty($description['necessite']) and is_string($description['necessite'])) {
    101101                                        $description['necessite'] = array($description['necessite']);
     
    113113                                if (!empty($description['necessite'])) {
    114114                                        foreach ($description['necessite'] as $_plugin_necessite) {
    115                                                 if (!defined('_DIR_PLUGIN_'.strtoupper($_plugin_necessite))) {
     115                                                if (!defined('_DIR_PLUGIN_' . strtoupper($_plugin_necessite))) {
    116116                                                        $type_noisette_a_garder = false;
    117117                                                        break;
     
    164164                // -- Insertion des nouveaux types de noisette.
    165165                if ($recharger
    166                 or (!$recharger and ($types_noisette_a_ajouter or $types_noisette_a_effacer or $types_noisette_a_changer))) {
     166                        or (!$recharger and ($types_noisette_a_ajouter or $types_noisette_a_effacer or $types_noisette_a_changer))) {
    167167                        $types_noisette = array('a_ajouter' => $types_noisette_a_ajouter);
    168168                        if (!$recharger) {
     
    185185 * @uses ncore_type_noisette_decrire()
    186186 *
    187  * @param string        $plugin
    188  *      Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou
    189  *      un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    190  *      La fonction utilisera la fonction de lecture de la description brute d'un type de noisette, spécifique
    191  *      au service, ou à défaut, celle fournie par N-Core.
    192  * @param string        $type_noisette
    193  *              Identifiant du type de noisette.
    194  * @param string        $information
    195  *              Information spécifique à retourner ou vide pour retourner toute la description.
    196  * @param boolean       $traiter_typo
    197  *      Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées
    198  *      en utilisant la fonction _T_ou_typo. Par défaut l'indicateur vaut `false`.
    199  *              Les champs sérialisés sont eux toujours désérialisés.
    200  * @param string        $stockage
    201  *      Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
    202  *      ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
    203  *              fournissant le service de stockage souhaité.
     187 * @param string  $plugin
     188 *        Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou
     189 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     190 *        La fonction utilisera la fonction de lecture de la description brute d'un type de noisette, spécifique
     191 *        au service, ou à défaut, celle fournie par N-Core.
     192 * @param string  $type_noisette
     193 *        Identifiant du type de noisette.
     194 * @param string  $information
     195 *        Information spécifique à retourner ou vide pour retourner toute la description.
     196 * @param boolean $traiter_typo
     197 *        Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées
     198 *        en utilisant la fonction _T_ou_typo. Par défaut l'indicateur vaut `false`.
     199 *        Les champs sérialisés sont eux toujours désérialisés.
     200 * @param string  $stockage
     201 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
     202 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
     203 *        fournissant le service de stockage souhaité.
    204204 *
    205205 * @return array|string
    206  *              La description complète ou champ précis demandé pour un type de noisette donné. Les champs
    207  *              de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être
    208  *              traités avec la fonction _T_ou_typo().
     206 *        La description complète ou champ précis demandé pour un type de noisette donné. Les champs
     207 *        de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être
     208 *        traités avec la fonction _T_ou_typo().
    209209 */
    210210function type_noisette_lire($plugin, $type_noisette, $information = '', $traiter_typo = false, $stockage = '') {
     
    268268 * @uses ncore_type_noisette_lister()
    269269 *
    270  * @param string        $plugin
    271  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
    272  *      ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    273  * @param array         $filtres
    274  *              Tableau associatif `[champ] = valeur` de critères de filtres sur les descriptions de types de noisette.
    275  *              Le seul opérateur possible est l'égalité.
    276  * @param string        $stockage
    277  *      Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
    278  *      ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
    279  *              fournissant le service de stockage souhaité.
     270 * @param string $plugin
     271 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
     272 *        ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     273 * @param array  $filtres
     274 *        Tableau associatif `[champ] = valeur` de critères de filtres sur les descriptions de types de noisette.
     275 *        Le seul opérateur possible est l'égalité.
     276 * @param string $stockage
     277 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
     278 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
     279 *        fournissant le service de stockage souhaité.
    280280 *
    281281 * @return array
    282  *              Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
     282 *        Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
    283283 */
    284284function type_noisette_repertorier($plugin, $filtres = array(), $stockage = '') {
  • _plugins_/n-core/trunk/inc/ncore_utils.php

    r105929 r106533  
    1414 * Si ni le service de stockage ni le plugin ne fournissent la fonction demandée la chaine vide est renvoyée.
    1515 *
    16  * @param string        $plugin
    17  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    18  *      un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    19  * @param bool          $fonction
    20  *      Nom de la fonction à chercher.
    21  * @param string        $stockage
    22  *      Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
    23  *      ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
    24  *              fournissant le service de stockage souhaité.
     16 * @param string $plugin
     17 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     18 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     19 * @param bool   $fonction
     20 *        Nom de la fonction à chercher.
     21 * @param string $stockage
     22 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
     23 *        ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
     24 *        fournissant le service de stockage souhaité.
    2525 *
    2626 * @return string
    27  *              Nom complet de la fonction si trouvée ou chaine vide sinon.
     27 *        Nom complet de la fonction si trouvée ou chaine vide sinon.
    2828 */
    2929function ncore_chercher_service($plugin, $fonction, $stockage = '') {
  • _plugins_/n-core/trunk/ncore/ncore.php

    r106527 r106533  
    2929 * @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
    3030 *
    31  * @uses    cache_lire()
    32  * @uses    cache_ecrire()
     31 * @uses cache_lire()
     32 * @uses cache_ecrire()
    3333 *
    3434 * @param string $plugin
     
    122122 * @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
    123123 *
    124  * @uses    cache_lire()
     124 * @uses cache_lire()
    125125 *
    126126 * @param string $plugin
     
    169169 * @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
    170170 *
    171  * @uses    cache_lire()
     171 * @uses cache_lire()
    172172 *
    173173 * @param string $plugin
     
    228228 * @package SPIP\NCORE\SERVICE\NOISETTE
    229229 *
    230  * @uses    ncore_chercher_service()
    231  * @uses    ncore_squelette_identifier()
     230 * @uses ncore_chercher_service()
     231 * @uses ncore_squelette_identifier()
    232232 *
    233233 * @param string $plugin
     
    312312 * @package SPIP\NCORE\SERVICE\NOISETTE
    313313 *
    314  * @uses    ncore_chercher_service()
    315  * @uses    ncore_squelette_identifier()
     314 * @uses ncore_chercher_service()
     315 * @uses ncore_squelette_identifier()
    316316 *
    317317 * @param string $plugin
     
    384384 * @package SPIP\NCORE\SERVICE\NOISETTE
    385385 *
    386  * @uses    ncore_chercher_service()
    387  * @uses    ncore_squelette_identifier()
    388  *
    389  * @param string $plugin
    390  *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    391  *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    392  * @param array|string  $description
     386 * @uses ncore_chercher_service()
     387 * @uses ncore_squelette_identifier()
     388 *
     389 * @param string       $plugin
     390 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     391 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     392 * @param array|string $description
    393393 *        Description complète de la noisette ou identifiant du squelette contextualisé.
    394  * @param string $stockage
     394 * @param string       $stockage
    395395 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
    396396 *        ne seront utilisés. En général, cet identifiant est le préfixe du plugin fournissant le stockage.
     
    457457 * @package SPIP\NCORE\SERVICE\NOISETTE
    458458 *
    459  * @uses    ncore_chercher_service()
    460  * @uses    ncore_squelette_identifier()
    461  *
    462  * @param string        $plugin
    463  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    464  *      un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    465  * @param string        $squelette
    466  *              Chemin relatif du squelette où ajouter la noisette.
    467  * @param array     $contexte
    468  *              Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
    469  * @param string    $information
    470  *      Champ précis de la description d'une noisette ou vide pour toute la description.
    471  * @param string    $cle
    472  *      Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit `id_noisette`
    473  *      soit `rang`.
     459 * @uses ncore_chercher_service()
     460 * @uses ncore_squelette_identifier()
     461 *
     462 * @param string $plugin
     463 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     464 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     465 * @param string $squelette
     466 *                Chemin relatif du squelette où ajouter la noisette.
     467 * @param array  $contexte
     468 *                Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
     469 * @param string $information
     470 *        Identifiant d'un champ de la description d'une type de noisette.
     471 *        Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
     472 *        un champ invalide la fonction renvoie un tableau vide.
     473 * @param string $cle
     474 *        Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit `id_noisette`
     475 *        soit `rang`.
    474476 * @param string $stockage
    475477 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
     
    532534 * @package SPIP\NCORE\SERVICE\NOISETTE
    533535 *
    534  * @uses    ncore_chercher_service()
    535  * @uses    ncore_squelette_identifier()
     536 * @uses ncore_chercher_service()
     537 * @uses ncore_squelette_identifier()
    536538 *
    537539 * @param string $plugin
     
    617619 * @package SPIP\NCORE\SERVICE\NOISETTE
    618620 *
    619  * @uses    ncore_chercher_service()
    620  *
    621  * @param string        $plugin
    622  *      Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
    623  *      un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
    624  * @param string        $squelette
    625  *              Chemin relatif du squelette où ajouter la noisette.
    626  * @param array     $contexte
    627  *              Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
     621 * @uses ncore_chercher_service()
     622 *
     623 * @param string $plugin
     624 *        Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
     625 *        un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
     626 * @param string $squelette
     627 *                Chemin relatif du squelette où ajouter la noisette.
     628 * @param array  $contexte
     629 *                Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
    628630 * @param string $stockage
    629631 *        Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
Note: See TracChangeset for help on using the changeset viewer.