Changeset 65738 in spip-zone


Ignore:
Timestamp:
Sep 11, 2012, 8:13:59 AM (8 years ago)
Author:
marcimat@…
Message:

Un peu de phpdoc de plus

Location:
_plugins_/fabrique/formulaires
Files:
4 edited

Legend:

Unmodified
Added
Removed

  • _plugins_/fabrique/formulaires/fabriquer_peuple.php

    r60510 r65738  
    11<?php
     2
     3/**
     4 * Gestion du formulaire permettant de créer un fichier de peuplement
     5 * d'une table SQL avec les données d'une table existante
     6 *
     7 * @package SPIP\Fabrique\Formulaires
     8 */
     9
     10// sécurité
    211if (!defined("_ECRIRE_INC_VERSION")) return;
    312
    4 
     13/**
     14 * Chargement du formulaire de fabrication de peuplement de table SQL
     15 *
     16 * @return array
     17 *     Environnement du formulaire
     18 */
    519function formulaires_fabriquer_peuple_charger_dist() {
    620        $contexte = array(
    … …  
    1226}
    1327
    14 
     28/**
     29 * Traitement du formulaire de fabrication de peuplement de table SQL
     30 *
     31 * @return array
     32 *     Retour des traitements
     33 */
    1534function formulaires_fabriquer_peuple_traiter_dist(){
    1635

  • _plugins_/fabrique/formulaires/fabriquer_plugin_actions.php

    r63512 r65738  
    11<?php
    22
     3
     4/**
     5 * Gestion des différentes actions du formulaire de construction de
     6 * plugin de la fabrique
     7 *
     8 * @package SPIP\Fabrique\Formulaires
     9 */
     10 
    311if (!defined("_ECRIRE_INC_VERSION")) return;
    412
    513
    6 // Effectue l'action demandee
    7 // et retourne le tableau de retour de traitement du formulaire
     14/**
     15 * Éffectue l'action demandée sur le formulaire de construction de plugin
     16 *
     17 * @param string $f_action
     18 *     Nom de l'action dans le constructeur de plugin de la fabrique,
     19 *     tel que 'ajouter_objet', 'supprimer_champ', ...
     20 * @param array $data
     21 *     Données de construction du plugin
     22 * @return
     23 *     Tableau de retour de traitement du formulaire
     24**/
    825function fabrique_action_modification_formulaire($f_action, $data) {
    926        // name="f_action[type]" ou "f_action[type][id]"
    … …  
    191208
    192209/**
    193  * Recupere les images uploades et les stocke dans la session
    194  *
     210 * Récupère les images uploadés et les stocke dans la session
     211 *
     212 * @param array $data
     213 *     Données de construction du plugin
     214 * @return void
    195215**/
    196216function fabrique_recuperer_et_stocker_les_images($data) {
    … …  
    254274 * Sauvegarder 10 exports de chaque plugins (en se basant sur le prefixe)
    255275 * ce qui permet de restaurer de vieilles versions.
    256  * Attention, cela ne sauve que le fichier d'export / import pour la Fabrique.
     276 *
     277 * @note
     278 *     Attention, cela ne sauve que le fichier d'export / import pour la Fabrique.
    257279 *
    258280 * @param string $fichier
    259  *              Fichier source a sauver
     281 *     Fichier source à sauver
    260282 * @param string $destination
    261  *              Répertoire de backup
    262  * @return null
     283 *     Répertoire de backup
     284 * @return void
    263285**/
    264286function fabrique_sauvegarde_tournante_export($fichier, $destination) {
    … …  
    289311
    290312/**
    291  * Generer un diff entre la precedente generation
    292  * du plugin et cette nouvelle creation
    293  *
    294  * Ce diff est affiche ensuite au retour du formulaire de creation
    295  * et egalement stocke dans le plugin cree, dans le fichier 'fabrique_diff.diff'
     313 * Générer un diff entre la précédente génération
     314 * du plugin et cette nouvelle création
     315 *
     316 * Ce diff est affiché ensuite au retour du formulaire de création
     317 * et également stocké dans le plugin crée, dans le fichier 'fabrique_diff.diff'
    296318 *
    297319 * @param string $ancien
    298  *              Chemin du repertoire de l'ancienne creation de plugin
     320 *    Chemin du répertoire de l'ancienne création de plugin
    299321 * @param string $nouveau
    300  *              Chemin du repertoire de la nouvelle creation
    301  * @return
    302  *              null
     322 *     Chemin du répertoire de la nouvelle création
     323 * @param string $prefixe
     324 *     Préfixe du plugin construit
     325 * @return void
    303326**/
    304327function fabrique_generer_diff($ancien, $nouveau, $prefixe) {
    … …  
    324347
    325348/**
    326  * Execute (uniquement si webmestre) des scripts saisis dans le formulaire
    327  * de creation de plugin.
     349 * Exécute (uniquement si webmestre) des scripts saisis dans le formulaire
     350 * de création de plugin.
    328351 * 
    329  *
    330352 * @param string $quoi
    331  *              Nom du type de script
     353 *     Nom du type de script
    332354 * @param array $data
    333  *              Toutes les infos du formulaire
     355 *     Données de construction du plugin
    334356 * @param array $contexte
    335  *              Variables disponibles pour les scripts (nom => valeur)
    336  * @return null
     357 *     Variables disponibles pour les scripts (nom => valeur)
     358 * @return null|void
     359 *     Null si le type de script n'est pas trouvé ou pas d'autorisation
     360 *     Void sinon.
    337361**/
    338362function fabrique_executer_script($quoi, $data, $contexte = array()) {

  • _plugins_/fabrique/formulaires/fabriquer_squelettes_fabrique.php

    r62623 r65738  
    11<?php
     2
     3/**
     4 * Gestion du formulaire permettant de préparer des gabarits de squelettes
     5 * pour la fabrique
     6 *
     7 * @package SPIP\Fabrique\Formulaires
     8 */
     9 
    210if (!defined("_ECRIRE_INC_VERSION")) return;
    311
    412
     13/**
     14 * Chargement du formulaire d'aide à la création de gabarits de squelette pour la fabrique
     15 *
     16 * @return array
     17 *     Environnement du formulaire
     18 */
    519function formulaires_fabriquer_squelettes_fabrique_charger_dist(){
    620        return array(
    … …  
    1428}
    1529
    16 
     30/**
     31 * Traitement du formulaire d'aide à la création de gabarits de squelette pour la fabrique
     32 *
     33 * @return array
     34 *     Retour des traitements
     35 */
    1736function formulaires_fabriquer_squelettes_fabrique_traiter_dist(){
    1837

  • _plugins_/fabrique/formulaires/reinitialiser_plugin.php

    r60510 r65738  
    11<?php
     2
     3/**
     4 * Gestion du formulaire permettant d'effacer toutes les données
     5 * du formulaire de fabrique afin de le réinitialiser
     6 *
     7 * @package SPIP\Fabrique\Formulaires
     8 */
     9
     10// sécurité
    211if (!defined("_ECRIRE_INC_VERSION")) return;
    312
    4 
     13/**
     14 * Chargement du formulaire de réinitialisation de la fabrique de plugin
     15 *
     16 * @return array
     17 *     Environnement du formulaire
     18 */
    519function formulaires_reinitialiser_plugin_charger_dist(){
    620        return array();
    721}
    822
     23/**
     24 * Traitement du formulaire de réinitialisation de la fabrique de plugin
     25 *
     26 * @return array
     27 *     Retour des traitements
     28 */
    929function formulaires_reinitialiser_plugin_traiter_dist(){
    1030
Note: See TracChangeset for help on using the changeset viewer.