Changeset 70030 in spip-zone


Ignore:
Timestamp:
Feb 20, 2013, 12:16:41 PM (7 years ago)
Author:
marcimat@…
Message:

La fabrique génère le phpDoc complet du plugin en même temps que ses fichiers.

Location:
_plugins_/fabrique/trunk/fabrique
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/fabrique/trunk/fabrique/base/importer_table.php.html

    r60510 r70030  
    33# Ces fichiers sont a placer dans le repertoire base/ de votre plugin
    44#
     5/**
     6 * Gestion de l'importation de `#TABLE_DESTINATION`
     7**/
    58
    69/**
    7  * Fonction d'import de la table #TABLE_DESTINATION
    8  * a utiliser dans le fichier d'administration du plugin
     10 * Fonction d'import de la table `#TABLE_DESTINATION`
     11 * à utiliser dans le fichier d'administration du plugin
    912 *
    10  * include_spip('base/importer_#TABLE_DESTINATION');
    11  * $maj['create'][] = array('importer_#TABLE_DESTINATION');
     13 *     ```
     14 *     include_spip('base/importer_#TABLE_DESTINATION');
     15 *     $maj['create'][] = array('importer_#TABLE_DESTINATION');
     16 *     ```
    1217 *
    1318**/
  • _plugins_/fabrique/trunk/fabrique/base/prefixe.php.html

    r64221 r70030  
    11#PHP
    2 [(#INCLURE{fond=fabrique/entetes/php,env})]
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Déclarations relatives à la base de données,
     4        package=Pipelines})]
    35
    46<BOUCLE_si_objets(CONDITION){si #OBJETS}>
    57/**
    68 * Déclaration des alias de tables et filtres automatiques de champs
     9 *
     10 * @pipeline declarer_tables_interfaces
     11 * @param array $interfaces
     12 *     Déclarations d'interface pour le compilateur
     13 * @return array
     14 *     Déclarations d'interface pour le compilateur
    715 */
    816function [(#PREFIXE)]_declarer_tables_interfaces($interfaces) {
     
    1624/**
    1725 * Déclaration des objets éditoriaux
     26 *
     27 * @pipeline declarer_tables_objets_sql
     28 * @param array $tables
     29 *     Description des tables
     30 * @return array
     31 *     Description complétée des tables
    1832 */
    1933function [(#PREFIXE)]_declarer_tables_objets_sql($tables) {
     
    8599/**
    86100 * Déclaration des tables secondaires (liaisons)
     101 *
     102 * @pipeline declarer_tables_auxiliaires
     103 * @param array $tables
     104 *     Description des tables
     105 * @return array
     106 *     Description complétée des tables
    87107 */
    88108function [(#PREFIXE)]_declarer_tables_auxiliaires($tables) {
  • _plugins_/fabrique/trunk/fabrique/formulaires/editer_objet.php.html

    r60510 r70030  
    11#PHP
    2 [(#INCLURE{fond=fabrique/entetes/php,env})]
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Gestion du formulaire de d'édition de #TYPE,
     4        package=Formulaires})]
    35
    46include_spip('inc/actions');
     
    2931]
    3032/**
    31  * Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite
     33 * Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité
     34 *
     35 * @param int|string $#ID_OBJET
     36 *     Identifiant du #TYPE. 'new' pour un nouveau #TYPE.[
     37 * @param int $(#GET{id_rubrique}|?{id_rubrique})
     38 *     Identifiant de la rubrique parente (si connue)]
     39 * @param string $retour
     40 *     URL de redirection après le traitement[
     41 * @param string $(#GET{associer}|?{associer_objet})
     42 *     Éventuel `objet|x` indiquant de lier le #TYPE créé à cet objet,
     43 *     tel que `article|3`]
     44 * @param int $lier_trad
     45 *     Identifiant éventuel d'un #TYPE source d'une traduction
     46 * @param string $config_fonc
     47 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     48 * @param array $row
     49 *     Valeurs de la ligne SQL du #TYPE, si connu
     50 * @param string $hidden
     51 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     52 * @return string
     53 *     Hash du formulaire
    3254 */
    3355function formulaires_editer_[(#TYPE)]_identifier_dist($#ID_OBJET='new',[ (#GET{id_rubrique_param})] $retour='',[ (#GET{associer_param})] $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     
    3658
    3759/**
    38  * Declarer les champs postes et y integrer les valeurs par defaut
     60 * Chargement du formulaire d'édition de #TYPE
     61 *
     62 * Déclarer les champs postés et y intégrer les valeurs par défaut
     63 *
     64 * @uses formulaires_editer_objet_charger()
     65 *
     66 * @param int|string $#ID_OBJET
     67 *     Identifiant du #TYPE. 'new' pour un nouveau #TYPE.[
     68 * @param int $(#GET{id_rubrique}|?{id_rubrique})
     69 *     Identifiant de la rubrique parente (si connue)]
     70 * @param string $retour
     71 *     URL de redirection après le traitement[
     72 * @param string $(#GET{associer}|?{associer_objet})
     73 *     Éventuel `objet|x` indiquant de lier le #TYPE créé à cet objet,
     74 *     tel que `article|3`]
     75 * @param int $lier_trad
     76 *     Identifiant éventuel d'un #TYPE 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 #TYPE, si connu
     81 * @param string $hidden
     82 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     83 * @return array
     84 *     Environnement du formulaire
    3985 */
    4086function formulaires_editer_[(#TYPE)]_charger_dist($#ID_OBJET='new',[ (#GET{id_rubrique_param})] $retour='',[ (#GET{associer_param})] $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     
    4490
    4591/**
    46  * Verifier les champs postes et signaler d'eventuelles erreurs
     92 * Vérifications du formulaire d'édition de #TYPE
     93 *
     94 * Vérifier les champs postés et signaler d'éventuelles erreurs
     95 *
     96 * @uses formulaires_editer_objet_verifier()
     97 *
     98 * @param int|string $#ID_OBJET
     99 *     Identifiant du #TYPE. 'new' pour un nouveau #TYPE.[
     100 * @param int $(#GET{id_rubrique}|?{id_rubrique})
     101 *     Identifiant de la rubrique parente (si connue)]
     102 * @param string $retour
     103 *     URL de redirection après le traitement[
     104 * @param string $(#GET{associer}|?{associer_objet})
     105 *     Éventuel `objet|x` indiquant de lier le #TYPE créé à cet objet,
     106 *     tel que `article|3`]
     107 * @param int $lier_trad
     108 *     Identifiant éventuel d'un #TYPE source d'une traduction
     109 * @param string $config_fonc
     110 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     111 * @param array $row
     112 *     Valeurs de la ligne SQL du #TYPE, si connu
     113 * @param string $hidden
     114 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     115 * @return array
     116 *     Tableau des erreurs
    47117 */
    48118function formulaires_editer_[(#TYPE)]_verifier_dist($#ID_OBJET='new',[ (#GET{id_rubrique_param})] $retour='',[ (#GET{associer_param})] $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
     
    51121
    52122/**
    53  * Traiter les champs postes
     123 * Traitement du formulaire d'édition de #TYPE
     124 *
     125 * Traiter les champs postés
     126 *
     127 * @uses formulaires_editer_objet_traiter()
     128 *
     129 * @param int|string $#ID_OBJET
     130 *     Identifiant du #TYPE. 'new' pour un nouveau #TYPE.[
     131 * @param int $(#GET{id_rubrique}|?{id_rubrique})
     132 *     Identifiant de la rubrique parente (si connue)]
     133 * @param string $retour
     134 *     URL de redirection après le traitement[
     135 * @param string $(#GET{associer}|?{associer_objet})
     136 *     Éventuel `objet|x` indiquant de lier le #TYPE créé à cet objet,
     137 *     tel que `article|3`]
     138 * @param int $lier_trad
     139 *     Identifiant éventuel d'un #TYPE source d'une traduction
     140 * @param string $config_fonc
     141 *     Nom de la fonction ajoutant des configurations particulières au formulaire
     142 * @param array $row
     143 *     Valeurs de la ligne SQL du #TYPE, si connu
     144 * @param string $hidden
     145 *     Contenu HTML ajouté en même temps que les champs cachés du formulaire.
     146 * @return array
     147 *     Retours des traitements
    54148 */
    55149function formulaires_editer_[(#TYPE)]_traiter_dist($#ID_OBJET='new',[ (#GET{id_rubrique_param})] $retour='',[ (#GET{associer_param})] $lier_trad=0, $config_fonc='', $row=array(), $hidden=''){
  • _plugins_/fabrique/trunk/fabrique/inc/precharger_objet.php.html

    r60510 r70030  
    11#PHP
    2 [(#INCLURE{fond=fabrique/entetes/php,env})]
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Préchargement des formulaires d'édition de #TYPE,
     4        package=Formulaires})]
    35
    46include_spip('inc/precharger_objet');
    57[(#ENV{objet/champ_titre}|non)
    68// /!\ Aucun champ de titre défini.
    7        Il vous faudra renseigner d'un champ SQL de votre objet le dernier paramètre des fonctions
    8        precharger_objet() et precharger_traduction_objet()
     9//       Il vous faudra renseigner d'un champ SQL de votre objet le dernier paramètre des fonctions
     10//       precharger_objet() et precharger_traduction_objet()
     11
    912]
     13/**
     14 * Retourne les valeurs à charger pour un formulaire d'édition d'un #TYPE
     15 *
     16 * Lors d'une création, certains champs peuvent être préremplis
     17 * (c'est le cas des traductions)
     18 *
     19 * @param string|int $#ID_OBJET
     20 *     Identifiant de #TYPE, ou "new" pour une création
     21 * @param int $id_rubrique
     22 *     Identifiant éventuel de la rubrique parente
     23 * @param int $lier_trad
     24 *     Identifiant éventuel de la traduction de référence
     25 * @return array
     26 *     Couples clés / valeurs des champs du formulaire à charger.
     27**/
    1028function inc_precharger_[(#TYPE)]_dist($#ID_OBJET, $id_rubrique=0, $lier_trad=0) {
    1129        return precharger_objet('#TYPE', $#ID_OBJET, $id_rubrique, $lier_trad, '#ENV{objet/champ_titre}');
    1230}
    1331
    14 // fonction facultative si pas de changement dans les traitements
     32/**
     33 * Récupère les valeurs d'une traduction de référence pour la création
     34 * d'un #TYPE (préremplissage du formulaire).
     35 *
     36 * @note
     37 *     Fonction facultative si pas de changement dans les traitements
     38 *
     39 * @param string|int $#ID_OBJET
     40 *     Identifiant de #TYPE, ou "new" pour une création
     41 * @param int $id_rubrique
     42 *     Identifiant éventuel de la rubrique parente
     43 * @param int $lier_trad
     44 *     Identifiant éventuel de la traduction de référence
     45 * @return array
     46 *     Couples clés / valeurs des champs du formulaire à charger
     47**/
    1548function inc_precharger_traduction_[(#TYPE)]_dist($#ID_OBJET, $id_rubrique=0, $lier_trad=0) {
    1649        return precharger_traduction_objet('#TYPE', $#ID_OBJET, $id_rubrique, $lier_trad, '#ENV{objet/champ_titre}');
  • _plugins_/fabrique/trunk/fabrique/prive/objets/liste/objets_associer_fonctions.php.html

    r60510 r70030  
    11#PHP
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Fonctions du squelette associé,
     4        package=Fonctions})]
    25
    3 if (!defined('_ECRIRE_INC_VERSION')) return;
    46
    57// pour initiale et afficher_initiale
  • _plugins_/fabrique/trunk/fabrique/prive/objets/liste/objets_lies_fonctions.php.html

    r60510 r70030  
    11#PHP
    2 
    3 if (!defined('_ECRIRE_INC_VERSION')) return;
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Fonctions du squelette associé,
     4        package=Fonctions})]
    45
    56// pour initiale et afficher_initiale
  • _plugins_/fabrique/trunk/fabrique/prive/objets/liste/objets_roles_associer_fonctions.php.html

    r64221 r70030  
    11#PHP
    2 
    3 if (!defined('_ECRIRE_INC_VERSION')) return;
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Fonctions du squelette associé,
     4        package=Fonctions})]
    45
    56// pour initiale et afficher_initiale
  • _plugins_/fabrique/trunk/fabrique/prive/objets/liste/objets_roles_lies_fonctions.php.html

    r64221 r70030  
    11#PHP
    2 
    3 if (!defined('_ECRIRE_INC_VERSION')) return;
     2[(#INCLURE{fond=fabrique/entetes/php,env,
     3        description=Fonctions du squelette associé,
     4        package=Fonctions})]
    45
    56// pour initiale et afficher_initiale
Note: See TracChangeset for help on using the changeset viewer.