Changeset 65731 in spip-zone


Ignore:
Timestamp:
Sep 10, 2012, 7:15:17 PM (7 years ago)
Author:
marcimat@…
Message:

Du phpdoc

Location:
_plugins_/saisies
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/saisies/balise/generer_saisies.php

    r33169 r65731  
    11<?php
     2
     3/**
     4 * Gestion de la balise GENERER_SAISIES
     5 *
     6 * @package SPIP\Saisies\Balises
     7 */
    28
    39// Sécurité
    410if (!defined("_ECRIRE_INC_VERSION")) return;
    511
     12/**
     13 * Compile la balise GENERER_SAISIES
     14 *
     15 * La balise accepte 1 paramètre qui est une liste de descriptions de saisies
     16 * dont on veut générer le HTML affichant les champs du formulaires
     17 *
     18 * Cette balise est un raccourcis :
     19 * - #GENERER_SAISIES{#TABLEAU_DE_SAISIES} est équivalent à
     20 * - #INCLURE{fond=generer_saisies,env,saisies=#TABLEAU_DE_SAISIES}
     21 *
     22 * @param Champ $p
     23 *     Pile au niveau de la balise
     24 * @return Champ
     25 *     Pile complété du code à générer
     26**/
    627function balise_GENERER_SAISIES_dist($p){
    728
  • _plugins_/saisies/inc/saisies.php

    r63487 r65731  
    11<?php
     2
     3/**
     4 * Gestion de l'affichage des saisies
     5 *
     6 * @return SPIP\Saisies\Saisies
     7**/
    28
    39// Sécurité
     
    109115}
    110116
    111 /*
     117/**
    112118 * Génère un nom unique pour un champ d'un formulaire donné
    113119 *
    114  * @param array $formulaire Le formulaire à analyser
    115  * @param string $type_saisie Le type de champ dont on veut un identifiant
    116  * @return string Un nom unique par rapport aux autres champs du formulaire
     120 * @param array $formulaire
     121 *     Le formulaire à analyser
     122 * @param string $type_saisie
     123 *     Le type de champ dont on veut un identifiant
     124 * @return string
     125 *     Un nom unique par rapport aux autres champs du formulaire
    117126 */
    118127function saisies_generer_nom($formulaire, $type_saisie){
  • _plugins_/saisies/inc/saisies_afficher.php

    r65542 r65731  
    11<?php
     2
     3/**
     4 * Gestion de l'affichage des saisies
     5 *
     6 * @return SPIP\Saisies\Afficher
     7**/
    28
    39// Sécurité
    410if (!defined('_ECRIRE_INC_VERSION')) return;
    511
    6 /*
     12/**
    713 * Indique si une saisie peut être affichée.
     14 *
    815 * On s'appuie sur l'éventuelle clé "editable" du $champ.
    916 * Si editable vaut :
    10  *  absent : le champ est éditable
    11  *  1, le champ est éditable
    12  *  0, le champ n'est pas éditable
    13  * -1, le champ est éditable s'il y a du contenu dans le champ (l'environnement)
    14  *     ou dans un de ses enfants (fieldsets)
    15  *
    16  * @param $champ tableau de description de la saisie
    17  * @param $env environnement transmis à la saisie, certainement l'environnement du formulaire
    18  * @param $utiliser_editable false pour juste tester le cas -1
     17 *    - absent : le champ est éditable
     18 *    - 1, le champ est éditable
     19 *    - 0, le champ n'est pas éditable
     20 *    - -1, le champ est éditable s'il y a du contenu dans le champ (l'environnement)
     21 *         ou dans un de ses enfants (fieldsets)
     22 *
     23 * @param array $champ
     24 *     Tableau de description de la saisie
     25 * @param array $env
     26 *     Environnement transmis à la saisie, certainement l'environnement du formulaire
     27 * @param bool $utiliser_editable
     28 *     - false pour juste tester le cas -1
    1929 *
    20  * @return bool Retourne un booléen indiquant l'état éditable ou pas
     30 * @return bool
     31 *     Retourne un booléen indiquant l'état éditable ou pas :
     32 *     - true si la saisie est éditable (peut être affichée)
     33 *     - false sinon
    2134 */
    2235function saisie_editable($champ, $env, $utiliser_editable=true) {
     
    5871}
    5972
    60 /*
     73/**
    6174 * Génère une saisie à partir d'un tableau la décrivant et de l'environnement
    62  * Le tableau doit être de la forme suivante :
    63  * array(
    64  *              'saisie' => 'input',
    65  *              'options' => array(
    66  *                      'nom' => 'le_name',
    67  *                      'label' => 'Un titre plus joli',
    68  *                      'obligatoire' => 'oui',
    69  *                      'explication' => 'Remplissez ce champ en utilisant votre clavier.'
    70  *              )
    71  * )
     75 *
     76 * @param array $champ
     77 *     Description de la saisie.
     78 *     Le tableau doit être de la forme suivante :
     79 *     array(
     80 *              'saisie' => 'input',
     81 *              'options' => array(
     82 *                      'nom' => 'le_name',
     83 *                      'label' => 'Un titre plus joli',
     84 *                      'obligatoire' => 'oui',
     85 *                      'explication' => 'Remplissez ce champ en utilisant votre clavier.'
     86 *              )
     87 *     )
     88 * @param array $env
     89 *     Environnement du formulaire
     90 *     Permet de savoir les valeurs actuelles des contenus des saisies,
     91 *     les erreurs eventuelles présentes...
     92 * @return string
     93 *     Code HTML des saisies de formulaire
    7294 */
    7395function saisies_generer_html($champ, $env=array()){
     
    157179}
    158180
    159 /*
     181/**
    160182 * Génère une vue d'une saisie à partir d'un tableau la décrivant
    161183 *
    162184 * @see saisies_generer_html()
    163  * @param array $saisie Un tableau décrivant une saisie
    164  * @param array $env L'environnement, contenant normalement la réponse à la saisie
     185 * @param array $saisie
     186 *     Tableau de description d'une saisie
     187 * @param array $env
     188 *     L'environnement, contenant normalement la réponse à la saisie
    165189 * @param array $env_obligatoire
    166  * @return string Retour le HTML des vues
     190 *     ???
     191 * @return string
     192 *     Code HTML de la vue de la saisie
    167193 */
    168194function saisies_generer_vue($saisie, $env=array(), $env_obligatoire=array()){
     
    193219                // par les modification sur l'environnement servant à generer la saisie mère
    194220                $contexte['_env'] = $env;
    195                                
     221
    196222                // À partir du moment où on passe tout l'environnement, il faut enlever
    197223                // certains éléments qui ne doivent absolument provenir que des options
     
    242268}
    243269
    244 /*
     270/**
    245271 * Génère, à partir d'un tableau de saisie le code javascript ajouté à la fin de #GENERER_SAISIES
    246  * pour produire un affichage conditionnel des saisies avec une option afficher_si.
    247  *
    248  * @param array $saisies Un tableau de saisies
    249  * @param string $id_form Un identifiant unique pour le formulaire
     272 * pour produire un affichage conditionnel des saisies ayant une option afficher_si.
     273 *
     274 * @param array $saisies
     275 *     Tableau de descriptions des saisies
     276 * @param string $id_form
     277 *     Identifiant unique pour le formulaire
    250278 * @return text
     279 *     Code javascript
    251280 */
    252281function saisies_generer_js_afficher_si($saisies,$id_form){
     
    323352}
    324353
    325 /*
     354/**
    326355 * Lorsque l'on affiche les saisies (#VOIR_SAISIES), les saisies ayant une option afficher_si
    327356 * et dont les conditions ne sont pas remplies doivent être retirées du tableau de saisies.
     357 *
    328358 * Cette fonction sert aussi lors de la vérification des saisies avec saisies_verifier().
    329  * A ce moment la, les saisies non affichees sont retirees de _request (on passe leur valeur a NULL).
    330  *
    331  * @param array $saisies Un tableau de saisies
    332  * @param array $env le tableau d'environnement transmis dans inclure/voi_saisies.html, NULL si on doit rechercher dans _request (pour saisies_verifier()).
    333  * @return array Un tableau de saisies
     359 * À ce moment là, les saisies non affichées sont retirées de _request
     360 * (on passe leur valeur à NULL).
     361 *
     362 * @param array $saisies
     363 *     Tableau de descriptions de saisies
     364 * @param array|null $env
     365 *     Tableau d'environnement transmis dans inclure/voi_saisies.html,
     366 *     NULL si on doit rechercher dans _request (pour saisies_verifier()).
     367 * @return array
     368 *     Tableau de descriptions de saisies
    334369 */
    335 
    336370function saisies_verifier_afficher_si($saisies, $env=NULL) {
    337371        // eviter une erreur par maladresse d'appel :)
  • _plugins_/saisies/inc/saisies_manipuler.php

    r65542 r65731  
    11<?php
     2
     3/**
     4 * Gestion de l'affichage des saisies
     5 *
     6 * @return SPIP\Saisies\Manipuler
     7**/
    28
    39// Sécurité
    410if (!defined('_ECRIRE_INC_VERSION')) return;
    511
    6 /*
     12/**
    713 * Supprimer une saisie dont on donne l'identifiant, le nom ou le chemin
    814 *
    9  * @param array $saisies Un tableau décriant les saisies
    10  * @param unknown_type $id_ou_nom_ou_chemin L'identifiant unique ou le nom de la saisie à supprimer ou son chemin sous forme d'une liste de clés
    11  * @return array Retourne le tableau modifié décrivant les saisies
     15 * @param array $saisies
     16 *     Tableau des descriptions de saisies
     17 * @param string|array $id_ou_nom_ou_chemin
     18 *     L'identifiant unique
     19 *     ou le nom de la saisie à supprimer
     20 *     ou son chemin sous forme d'une liste de clés
     21 * @return array
     22 *     Tableau modifié décrivant les saisies
    1223 */
    1324function saisies_supprimer($saisies, $id_ou_nom_ou_chemin){
     
    3142}
    3243
    33 /*
     44/**
    3445 * Insère une saisie à une position donnée
    35  *
    36  * @param array $saisies Un tableau décrivant les saisies
    37  * @param array $saisie La saisie à insérer
    38  * @param array $chemin La position complète où insérer la saisie
    39  * @return array Retourne le tableau modifié des saisies
     46 *
     47 * @param array $saisies
     48 *     Tableau des descriptions de saisies
     49 * @param array $saisie
     50 *     Description de la saisie à insérer
     51 * @param array $chemin
     52 *     Position complète où insérer la saisie.
     53 *     En absence, insère la saisie à la fin.
     54 * @return array
     55 *     Tableau des saisies complété de la saisie insérée
    4056 */
    4157function saisies_inserer($saisies, $saisie, $chemin=array()){
     
    206222}
    207223
    208 /*
     224/**
    209225 * Transforme tous les noms du formulaire avec un preg_replace
    210226 *
    211  * @param array $saisies Un tableau décrivant les saisies
    212  * @param string $masque Ce que l'on doit chercher dans le nom
    213  * @param string $remplacement Ce par quoi on doit remplacer
    214  * @return array Retourne le tableau modifié des saisies
     227 * @param array $saisies
     228 *     Un tableau décrivant les saisies
     229 * @param string $masque
     230 *     Ce que l'on doit chercher dans le nom
     231 * @param string $remplacement
     232 *     Ce par quoi on doit remplacer
     233 * @return array
     234 *     Retourne le tableau modifié des saisies
    215235 */
    216236function saisies_transformer_noms($saisies, $masque, $remplacement){
     
    227247}
    228248
    229 /*
     249/**
    230250 * Transforme les noms d'une liste de saisies pour qu'ils soient
    231251 * uniques dans le formulaire donné.
    232252 *
    233  * @param array $formulaire Le formulaire à analyser
    234  * @param array $saisies Un tableau décrivant les saisies.
    235  * @return array Retourne le tableau modifié des saisies
     253 * @param array $formulaire
     254 *     Le formulaire à analyser
     255 * @param array $saisies
     256 *     Un tableau décrivant les saisies.
     257 * @return array
     258 *     Retourne le tableau modifié des saisies
    236259 */
    237260function saisies_transformer_noms_auto($formulaire, $saisies){
Note: See TracChangeset for help on using the changeset viewer.