Changeset 65708 in spip-zone


Ignore:
Timestamp:
Sep 10, 2012, 8:40:05 AM (7 years ago)
Author:
marcimat@…
Message:

Un peu de phpdoc sur le code de la fabrique (pas sur le code généré)

Location:
_plugins_/fabrique
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/fabrique/fabrique/base/importer_table.php_fonctions.php

    r60510 r65708  
    11<?php
     2
     3/**
     4 * Options globales chargées à chaque hit
     5 *
     6 * @package SPIP\Fabrique\Templates
     7**/
    28
    39
    410/**
    5  * On extrait les donnees de la table
    6  * et on essaie de leur faire prendre moins de place
    7  * en ecrivant une seule fois leurs noms de colonne.
     11 * Extrait toutes les données d'une table
     12 * et essaie de leur faire prendre moins de place
     13 * en n'ecrivant qu'une seule fois leurs noms de colonne.
    814 *
    915 * @param string $table
    10  *              Nom de la table SQL a extraire
     16 *     Nom de la table SQL a extraire
    1117 * @param string $connect
    12  *              Connecteur de la base de données
     18 *     Connecteur de la base de données
    1319 * @return array
    14  *              Tableau de deux elements : la liste des cles,
    15  *              et la liste dans un tableau de toutes les donnees.
     20 *     Tableau de deux elements : la liste des cles,
     21 *     et la liste dans un tableau de toutes les donnees.
    1622**/
    1723function fabrique_extraire_les_donnees_table($table, $connect) {
  • _plugins_/fabrique/fabrique_fonctions.php

    r64221 r65708  
    11<?php
    22
     3/**
     4 * Fonctions utiles pour les squelettes de la fabrique
     5 *
     6 * @package SPIP\Fabrique\Fonctions
     7**/
     8
    39if (!defined("_ECRIRE_INC_VERSION")) return;
    410
    511
    612/**
    7  * Determiner le repertoire de travail
    8  * de la Fabrique. Dans
     13 * Déterminer le répertoire de travail
     14 * de la Fabrique.
     15 *
     16 * Dans :
    917 * - plugins/fabrique_auto si possible, sinon dans
    1018 * - tmp/cache/fabrique
    1119 *
    1220 * @return string
    13  *              Le chemin de destination depuis la racine de SPIP.
     21 *     Le chemin de destination depuis la racine de SPIP.
    1422**/
    1523function fabrique_destination() {
     
    2836
    2937/**
    30  * Crée l'arborescence manquante
    31  * sous_repertoire_complet('a/b/c/d');
    32  * appelle sous_repertoire() autant de fois que necessaire.
     38 * Crée l'arborescence manquante
     39 *
     40 * Crée tous les répertoires manquants dans une arborescence donnée.
     41 * Les répertoires sont séparés par des '/'
     42 *
     43 * @example
     44 *     sous_repertoire_complet('a/b/c/d');
     45 *     appelle sous_repertoire() autant de fois que nécéssaire.
     46 *
     47 * @param string $arbo
     48 *     Arborescence, tel que 'prive/squelettes/contenu'
     49 * @return void
    3350**/
    3451function sous_repertoire_complet($arbo) {
     
    5168
    5269/**
    53  * Concatene en utilisant implode un tableau, de maniere recursive
     70 * Concatène en utilisant implode, un tableau, de maniere récursive
    5471 *
    5572 * @param array $tableau
    56  *              Tableau a transformer
     73 *     Tableau à transformer
    5774 * @param string $glue
    58  *              Chaine inseree entre les valeurs
    59  * @return string
    60  *              Chaine concatenee
     75 *     Chaine insérée entre les valeurs
     76 * @return string|bool
     77 *     - False si pas un tableau
     78 *     - Chaine concaténée sinon
    6179**/
    6280function fabrique_implode_recursif($tableau, $glue='') {
     
    7694
    7795/**
    78  * Fait écrire <?php 
    79  * sans que ce php soit execute par SPIP !
     96 * Écrit une ouverture de code PHP
     97 *
     98 * Fait écrire '<?php' sans que ce php soit executé par SPIP !
     99 *
     100 * @param Champ $p
     101 *     Pile au niveau de la balise
     102 * @return Champ
     103 *     Pile complétée du code à produire
    80104**/
    81105function balise_PHP_dist($p) {
     
    86110
    87111/**
    88  * Convertie une chaine pour en faire une chaine de langue
    89  * &#xxx => le bon caractère
    90  * ' => \'
    91  *
     112 * Convertie une chaîne pour en faire une chaîne de langue
     113 *
     114 * Permet d'insérer un texte comme valeur d'une clé de langue, lorsqu'on
     115 * crée un fichier de langue avec la fabrique.
     116 *
     117 * Transforme les caractères &# et échappe les apostrophes :
     118 * - &#xxx => le bon caractère
     119 * - ' => \'
     120 *
     121 * @example
     122 *     '#ENV{prefixe}_description' => '[(#ENV{paquet/description}|chaine_de_langue)]',
     123 *
     124 * @link http://www.php.net/manual/fr/function.html-entity-decode.php#104617
     125 * @param string $texte
     126 *     Le texte à écrire dans la chaîne de langue
     127 * @return string
     128 *     Le texte transformé
    92129**/
    93130function chaine_de_langue($texte) {
     
    100137
    101138/**
    102  * Modifie le nom de la cle de langue pour
     139 * Modifie le nom de la clé de langue pour
    103140 * utiliser le vrai nom de l'objet
    104141 *
    105  * titre_objets => titre_chats
    106  * icone_creer_objet => icone_creer_chat
     142 * Remplace 'objets' par le nom de l'objet, et 'objet' par le type d'objet,
     143 * mais ne touche pas à '\objets' ou '\objet'.
     144 *
     145 * @note
     146 *     Cette fonction ne sert pas uniquement à définir des clés pour
     147 *     les fichiers de chaînes de langue, et pourrait être renommée
     148 *
     149 * @example
     150 *     cle_de_langue('titre_objets') => titre_chats
     151 *     cle_de_langue('icone_creer_objet') => icone_creer_chat
     152 *     cle_de_langue('prive/\objets/infos/objet.html') => prive/objets/infos/chat.html
     153 * @param string $cle
     154 *     La clé à transformer
     155 * @param array $desc_objet
     156 *     Couples d'information sur l'objet en cours, avec les index
     157 *     'objet' et 'type' définis
     158 * @retrun string
     159 *     La clé transformée
    107160**/
    108161function cle_de_langue($cle, $desc_objet) {
     
    118171
    119172/**
    120  * Identique a |cle_de_langue sur toutes les valeurs d'un tableau
    121  *
     173 * Identique à |cle_de_langue sur toutes les valeurs d'un tableau
     174 *
     175 * @see cle_de_langue()
     176 * @param array $tableau
     177 *     Tableau dont on veut transformer les valeurs
     178 * @param array $desc_objet
     179 *     Couples d'information sur l'objet en cours, avec les index
     180 *     'objet' et 'type' définis
     181 * @return array
     182 *     Tableau avec les valeurs transformées
    122183**/
    123184function tab_cle_de_langue($tableau, $desc_objet) {
     
    129190
    130191/**
    131  * Cherche s'il existe une chaine de langue pour les cles de tableaux
     192 * Cherche s'il existe une chaîne de langue pour les clés de tableaux
    132193 * et ajoute alors la traduction dans la valeur de ce tableau
    133194 *
    134195 * @param array $tableau
    135  *              Tableau cle => texte
     196 *     Couples (clé => texte)
    136197 * @param string $prefixe_cle
    137  *              Prefixe ajoute aux cles pour chercher les trads
     198 *     Préfixe ajouté aux clés pour chercher les trads
    138199 * @param string $sep
    139  *              Séparateur entre l'ancienne valeur et la concaténation de traduction
    140  * @return array
    141  *              Le tableau complété
     200 *     Séparateur entre l'ancienne valeur et la concaténation de traduction
     201 * @return array
     202 *     Couples (clé => texte complété de la traduction si elle existe)
    142203**/
    143204function tab_cle_traduite_ajoute_dans_valeur($tableau, $prefixe_cle="", $sep = "&nbsp;: ") {
     
    157218 *
    158219 * @param array $tableau
    159  *              Tableau cle => texte
     220 *     Tableau cle => texte
    160221 * @param string $balise
    161  *              Balise qui encapsule
     222 *     Balise qui encapsule
    162223 * @return array $tableau
    163  *              Tableau cle => <balise>texte</balise>
     224 *     Tableau clé => <balise>texte</balise>
    164225**/
    165226function tab_wrap($tableau, $balise) {
     
    172233
    173234/**
    174  * Fabrique un tableau de chaines de langues
    175  * avec des cles d'origines passees dans la fonctions
    176  * cle_de_langue, et trie.
     235 * Fabrique un tableau de chaînes de langues
     236 * avec des clés d'origines passées dans la fonctions
     237 * cle_de_langue, et trie.
     238 *
     239 * @param array $objet
     240 *     Description de l'objet dans la fabrique
     241 * @return array
     242 *     Couples (clé de langue => Texte)
    177243**/
    178244function fabriquer_tableau_chaines($objet) {
     
    204270}
    205271
    206 /*
     272/**
    207273 * Retourne la description des rôles pour un objet
    208274 *
    209  * @param array $objet Descrption de l'objet
    210  * @return array Description des roles
    211  *     4 index :
     275 * @param array $objet
     276 *     Descrption de l'objet
     277 * @return array
     278 *     Description des rôles. 4 index :
    212279 *     - roles_colonne : la colonne utilisée, toujours 'role'
    213  *     - roles_titre : couples clé du role, clé de langue du role
    214  *     - roles_objets : tableau objet => liste des clés de roles
    215  *     - roles_trads : couples clé de langue => Texte
    216  *     - roles_defaut : la clé du role par défaut
     280 *     - roles_titre   : couples clé du role, clé de langue du role
     281 *     - roles_objets  : tableau objet => liste des clés de roles
     282 *     - roles_trads   : couples clé de langue => Texte
     283 *     - roles_defaut  : la clé du role par défaut
    217284 */
    218285function fabrique_description_roles($objet) {
     
    248315/**
    249316 * Indique si le champ est présent dans l'objet
    250  * (un champ au sens sql)
     317 *
     318 * Champ, au sens de colonne SQL
     319 *
     320 * @param array $objet
     321 *     Descrption de l'objet
     322 * @param string $champ
     323 *     Nom du champ SQL à tester
     324 * @return string
     325 *     Même retour que le filtre |oui :
     326 *     - Un espace si le champ SQL exsitera dans l'objet
     327 *     - Chaîne vide sinon
    251328**/
    252329function champ_present($objet, $champ) {
     
    292369/**
    293370 * Indique si toutes les options sont présentes dans l'objet
    294  * (c'est a dire une cle de configuration, pas un nom de champ SQL)
     371 *
     372 * Option au sens de clé de configuration, pas un nom de champ SQL
     373 *
     374 * @param array $objet
     375 *     Descrption de l'objet
     376 * @param array $champs
     377 *     Liste de nom d'options à tester
     378 * @return string
     379 *     Même retour que le filtre |oui :
     380 *     - Un espace si toutes les options sont présentes dans l'objet
     381 *     - Chaîne vide sinon
    295382**/
    296383function options_presentes($objet, $champs) {
     
    308395/**
    309396 * Indique si une option est présente dans l'objet
    310  * (c'est a dire une cle de configuration, pas un nom de champ SQL)
     397 *
     398 * Option au sens de clé de configuration, pas un nom de champ SQL
     399 *
     400 * @param array $objet
     401 *     Descrption de l'objet
     402 * @param array $champ
     403 *     Nom de l'option à tester
     404 * @return string
     405 *     Même retour que le filtre |oui :
     406 *     - Un espace si l'option est présente dans l'objet
     407 *     - Chaîne vide sinon
    311408**/
    312409function option_presente($objet, $champ) {
     
    341438
    342439
    343 // indique si une option donnée est presente dans le champ
     440/**
     441 * Indique si une option donnée est presente dans la définition d'un champ
     442 * de la fabrique
     443 *
     444 * @param array $champ
     445 *     Description d'un champ SQL d'un objet créé avec la fabrique
     446 * @param string $option
     447 *     Option testée
     448 * @return string
     449 *     Même retour que le filtre |oui :
     450 *     - Un espace si l'option est présente dans le champ de l'objet
     451 *     - Chaîne vide sinon
     452 */
    344453function champ_option_presente($champ, $option) {
    345454        if (isset($champ[$option]) and $champ[$option]) {
     
    358467
    359468/**
    360  * Retourne les objets possedant un certain champ (au sens sql)
     469 * Retourne les objets possédant un certain champ SQL
     470 *
    361471 * Cela simplifie des boucles DATA
    362  * #OBJETS|objets_champ_present{id_rubrique}
    363  *
    364  * On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
    365  * #OBJETS|objets_champ_present{id_rubrique, objet} // chats,souris
     472 *
     473 * @example
     474 *     #OBJETS|objets_champ_present{id_rubrique}
     475 *
     476 *     On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
     477 *     #OBJETS|objets_champ_present{id_rubrique, objet} // chats,souris
     478 *
     479 * @param array $objets
     480 *     Liste des descriptions d'objets créés avec la fabrique
     481 * @param string $champ
     482 *     Type de champ sélectionné
     483 * @param string $type
     484 *     Information de retour désiré :
     485 *     - vide pour toute la description de l'objet
     486 *     - clé dans la description de l'objet pour obtenir uniquement ces descriptions
     487 * @return array
     488 *     - tableau de description des objets sélectionnés (si type non défini)
     489 *     - tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)
    366490**/
    367491function objets_champ_present($objets, $champ, $type='') {
     
    371495
    372496/**
    373  * Retourne les objets possedant une certaine option
    374  * (au sens des cles du formulaire de configuration de l'objet)
    375  *
    376  * #OBJETS|objets_option_presente{vue_rubrique}
    377  * #OBJETS|objets_option_presente{auteurs_liens}
    378  *
    379  * On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
    380  * #OBJETS|objets_option_presente{auteurs_liens, objet} // chats,souris
    381  *
     497 * Retourne les objets possédant une certaine option
     498 *
     499 * Option au sens des clés du formulaire de configuration de l'objet
     500 *
     501 * @example
     502 *     #OBJETS|objets_option_presente{vue_rubrique}
     503 *     #OBJETS|objets_option_presente{auteurs_liens}
     504 *
     505 *     On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
     506 *     #OBJETS|objets_option_presente{auteurs_liens, objet} // chats,souris
     507 *
     508 * @param array $objets
     509 *     Liste des descriptions d'objets créés avec la fabrique
     510 * @param string $option
     511 *     Type d'option sélectionnée
     512 * @param string $type
     513 *     Information de retour désiré :
     514 *     - vide pour toute la description de l'objet
     515 *     - clé dans la description de l'objet pour obtenir uniquement ces descriptions
     516 * @return array
     517 *     - tableau de description des objets sélectionnés (si type non défini)
     518 *     - tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)
    382519**/
    383520function objets_option_presente($objets, $option, $type='') {
     
    387524
    388525/**
    389  * Retourne les objets possedant plusieurs options
    390  * (au sens des cles du formulaire de configuration de l'objet)
    391  *
    392  * #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}}
    393  *
    394  * On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
    395  * #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}, objet} // chats,souris
    396  *
     526 * Retourne les objets possédant plusieurs options
     527 *
     528 * Option au sens des clés du formulaire de configuration de l'objet
     529 *
     530 * @example
     531 *     #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}}
     532 *
     533 *     On peut ne retourner qu'une liste de type de valeur (objet, type, id_objet)
     534 *     #OBJETS|objets_options_presentes{#LISTE{table_liens,vue_liens}, objet} // chats,souris
     535 *
     536 * @param array $objets
     537 *     Liste des descriptions d'objets créés avec la fabrique
     538 * @param array $options
     539 *     Liste de type d'option à sélectionner
     540 * @param string $type
     541 *     Information de retour désiré :
     542 *     - vide pour toute la description de l'objet
     543 *     - clé dans la description de l'objet pour obtenir uniquement ces descriptions
     544 * @return array
     545 *     - tableau de description des objets sélectionnés (si type non défini)
     546 *     - tableau les valeurs du type demandé dans les objets sélectionnés (si type défini)
    397547**/
    398548function objets_options_presentes($objets, $options, $type='') {
     
    401551
    402552/**
    403  * Retourne des champs en fonction des options trouvees
    404  * #CHAMPS|champs_option_presente{editable}
    405  * #CHAMPS|champs_option_presente{versionne}
     553 * Retourne des champs en fonction d'une option trouvée
     554 *
     555 * @example
     556 *     #CHAMPS|champs_option_presente{editable}
     557 *     #CHAMPS|champs_option_presente{versionne}
     558 *
     559 * @param array $champs
     560 *     Liste des descriptions de champs d'un objet créé avec la fabrique
     561 * @param string $option
     562 *     Type d'option sélectionnée
     563 * @param string $type
     564 *     Information de retour désiré :
     565 *     - vide pour toute la description du champ
     566 *     - clé dans la description du champ pour obtenir uniquement ces descriptions
     567 * @return array
     568 *     - tableau de description des champs sélectionnés (si type non défini)
     569 *     - tableau les valeurs du type demandé dans les champs sélectionnés (si type défini)
    406570**/
    407571function champs_option_presente($champs, $option, $type='') {
     
    410574
    411575/**
    412  * Retourne des champs en fonction des options trouvees
    413  * #CHAMPS|champs_options_presentes{#LISTE{obligatoire,saisie}}
     576 * Retourne des champs en fonction des options trouvées
     577 *
     578 * @example
     579 *     #CHAMPS|champs_options_presentes{#LISTE{obligatoire,saisie}}
     580 *
     581 * @param array $champs
     582 *     Liste des descriptions de champs d'un objet créé avec la fabrique
     583 * @param array $options
     584 *     Liste de type d'options à sélectionner
     585 * @param string $type
     586 *     Information de retour désiré :
     587 *     - vide pour toute la description du champ
     588 *     - clé dans la description du champ pour obtenir uniquement ces descriptions
     589 * @return array
     590 *     - tableau de description des champs sélectionnés (si type non défini)
     591 *     - tableau les valeurs du type demandé dans les champs sélectionnés (si type défini)
    414592**/
    415593function champs_options_presentes($champs, $options, $type='') {
     
    418596
    419597
    420 // fonction generique pour retourner une liste de choses dans un tableau
     598/**
     599 * Fonction générique pour retourner une liste de choses dans un tableau
     600 *
     601 * @param string $func
     602 *     Nom de la fonction à appeler, tel que
     603 *     - champ_option_presente
     604 *     - option_presente
     605 *     - ...
     606 * @param array $tableau
     607 *     Tableau de descriptions (descriptions d'objet ou descriptions de champ d'objet)
     608 * @param string $option
     609 *     Nom de l'option dont on teste la présence
     610 * @param string $type
     611 *     Information de retour désiré :
     612 *     - vide pour toute la description
     613 *     - clé dans la description pour obtenir uniquement ces descriptions
     614 * @return array
     615 *     Liste des descriptions correspondant à l'option demandée
     616 */
    421617function _tableau_option_presente($func, $tableau, $option, $type='') {
    422618        $o = array();
     
    443639}
    444640
    445 // fonction generique pour retourner une liste de choses multiples dans un tableau
     641/**
     642 * Fonction générique pour retourner une liste de choses multiples dans un tableau
     643 *
     644 * @param string $func
     645 *     Nom de la fonction à appeler, tel que
     646 *     - champ_option_presente
     647 *     - option_presente
     648 *     - ...
     649 * @param array $tableau
     650 *     Tableau de descriptions (descriptions d'objet ou descriptions de champ d'objet)
     651 * @param array $options
     652 *     Nom des l'options dont on teste leur présence
     653 * @param string $type
     654 *     Information de retour désiré :
     655 *     - vide pour toute la description
     656 *     - clé dans la description pour obtenir uniquement ces descriptions
     657 * @return array
     658 *     Liste des descriptions correspondant aux options demandées
     659 */
    446660function _tableau_options_presentes($func, $tableau, $options, $type='') {
    447661        if (!$options) return array();
     
    476690 * Retourne une ecriture de criteres
    477691 * {id_parent?}{id_documentation?}
    478  * avec tous les champs id_x declares dans l'interface
     692 * avec tous les champs id_x declarés dans l'interface
    479693 * dans la liste des champs.
    480694 *
     
    483697 *
    484698 * @param array $objet
    485  *              Description de l'objet
    486  * @return string
    487  *              L'écriture des criteres de boucle
     699 *     Description de l'objet dans la fabrique
     700 * @return string
     701 *     L'écriture des critères de boucle
    488702**/
    489703function criteres_champs_id($objet) {
     
    506720 * pour tous les objets.
    507721 *
    508  * Avec le second paramètre, on peut ne récupérer que :
    509  * - 'tout' => toutes les tables (par défaut)
    510  * - 'objets' => les tables d'objet (spip_xx, spip_yy)
    511  * - 'liens' => les tables de liens (spip_xx_liens, spip_yy_liens)
    512  *
     722 * @param array $objets
     723 *     Liste des descriptions d'objets créés avec la fabrique
     724 * @param string $quoi
     725 *     Choix du retour désiré :
     726 *     - 'tout'   => toutes les tables (par défaut)
     727 *     - 'objets' => les tables d'objet (spip_xx, spip_yy)
     728 *     - 'liens'  => les tables de liens (spip_xx_liens, spip_yy_liens)
     729 * @return array
     730 *     Liste des tables
    513731**/
    514732function fabrique_lister_tables($objets, $quoi='tout') {
     
    543761
    544762
    545 // indique si un des objets a besoin du pipeline demande
     763/**
     764 * Indique si un des objets a besoin du pipeline demandé
     765 *
     766 * @param array $objets
     767 *     Liste des descriptions d'objets créés avec la fabrique
     768 * @param string $pipeline
     769 *     Nom du pipeline
     770 * @return array
     771 *     Liste des objets (descriptions) utilisant le pipeline
     772 */
    546773function fabrique_necessite_pipeline($objets, $pipeline) {
    547774
     
    594821
    595822/**
    596  * Un peu equivalent a var_export
    597  * si $quote = true, on applique sql_quote sur tous les champs
     823 * Crée le code PHP de création d'un tableau
     824 *
     825 * Fonction un peu équivalente à var_export()
    598826 *
    599827 * @param array $tableau
    600  *              Le tableau dont on veut obtenir le code de creation array( ... )
     828 *     Le tableau dont on veut obtenir le code de création array( ... )
    601829 * @param bool $quote
    602  *              Appliquer sql_quote() sur chaque valeur (dans le code retourne)
     830 *     Appliquer sql_quote() sur chaque valeur (dans le code retourne)
    603831 * @param string $defaut
    604  *              Si $tableau est vide ou n'est pas une chaine, la fonction retourne cette valeur
    605  * @return string
    606  *              Le code de creation du tableau, avec eventuellement le code pour appliquer sql_quote.
    607  *
     832 *     Si $tableau est vide ou n'est pas une chaîne, la fonction retourne cette valeur
     833 * @return string
     834 *     - Le code de création du tableau, avec éventuellement le code pour appliquer sql_quote.
     835 *     - $defaut si le tableau est vide
    608836**/
    609837function ecrire_tableau($tableau, $quote = false, $defaut = "array()") {
     
    622850
    623851/**
    624  * Identique a ecrire_tableau() mais ne retourne rien si le tableau est vide
    625  *
     852 * Crée le code PHP de création d'un tableau sauf s'il est vide
     853 *
     854 * Identique à ecrire_tableau() mais ne retourne rien si le tableau est vide
     855 * @see ecrire_tableau()
     856 *
     857 * @param array $tableau
     858 *     Le tableau dont on veut obtenir le code de création array( ... )
     859 * @param bool $quote
     860 *     Appliquer sql_quote() sur chaque valeur (dans le code retourne)
     861 * @return string
     862 *     - Le code de création du tableau, avec éventuellement le code pour appliquer sql_quote.
     863 *     - Chaîne vide si le tableau est vide
    626864**/
    627865function ecrire_tableau_sinon_rien($tableau, $quote = false) {
     
    629867}
    630868
    631 // un peu equivalent a str_pad mais avec une valeur par defaut.
     869/**
     870 * Ajoute autant des espaces à la fin d'une chaîne jusqu'à la taille indiquée
     871 *
     872 * Fonction un peu equivalente à str_pad() mais avec une valeur par défaut
     873 * définie par la constante _FABRIQUE_ESPACER
     874 *
     875 * @param string $texte
     876 *     Texte à compléter
     877 * @param int $taille
     878 *     Taille spécifique, utilisée à la place de la constante si renseignée
     879 * @return
     880 *     Texte complété des espaces de fin
     881 */
    632882function espacer($texte, $taille = 0) {
    633883        if (!$taille) $taille = _FABRIQUE_ESPACER;
     
    636886
    637887
    638 // tabule a gauche chaque ligne du nombre de tabulations indiquees
    639 // + on enleve les espaces sur les lignes vides
     888/**
     889 * Tabule à gauche chaque ligne du nombre de tabulations indiquées
     890 * + on enleve les espaces sur les lignes vides
     891 *
     892 * @param string $texte
     893 *     Un texte, qui peut avoir plusieurs lignes
     894 * @param int $nb_tabulations
     895 *     Nombre de tabulations à appliquer à gauche de chaque ligne
     896 * @return string
     897 *     Texte indenté du nombre de tabulations indiqué
     898 */
    640899function fabrique_tabulations($texte, $nb_tabulations) {
    641900        $tab = "";
     
    659918
    660919/**
    661  * Passer en majuscule en utilisant mb de preference
     920 * Passer en majuscule en utilisant mb de préférence
    662921 * s'il est disponible.
    663922 *
    664923 * @param string $str
    665  *              La chaine a passer en majuscule
    666  * @return string
    667  *              La chaine en majuscule
     924 *     La chaine à passer en majuscule
     925 * @return string
     926 *     La chaine en majuscule
    668927**/
    669928function fabrique_mb_strtoupper($str) {
     
    676935
    677936/**
    678  * Passer en minuscule en utilisant mb de preference
     937 * Passer en minuscule en utilisant mb de préférence
    679938 * s'il est disponible.
    680939 *
    681940 * @param string $str
    682  *              La chaine a passer en minuscule
     941 *              La chaine à passer en minuscule
    683942 * @return string
    684943 *              La chaine en minuscule
     
    693952
    694953
    695 // Afficher une image a partir d'un fichier, selon une reduction donnee
    696 // (evite un |array_shift qui passe pas en PHP 5.4)
    697 // Attention à bien rafraichir l'image reduite lorsqu'on change de logo
    698 // #URL_IMAGE|image_reduire{128}|extraire_attribut{src}|explode{?}|array_shift|timestamp|balise_img
     954/**
     955 * Crée une balise HTML <img> à partir d'un fichier,
     956 * réactualisée à chaque calcul, selon une réduction donnée.
     957 *
     958 * Cela évite un |array_shift qui ne passe pas en PHP 5.4
     959 *
     960 * Attention à bien rafraîchir l'image réduite lorsqu'on change de logo.
     961 *
     962 * @example
     963 *     #URL_IMAGE|fabrique_miniature_image{128}
     964 *
     965 *     Applique l'équivalent de :
     966 *     #URL_IMAGE|image_reduire{128}|extraire_attribut{src}
     967 *         |explode{?}|array_shift|timestamp|balise_img
     968 *
     969 * @param string $fichier
     970 *     Chemin du fichier
     971 * @param int $taille
     972 *     Taille de réduction de l'image
     973 * @return string
     974 *     Balise HTML IMG de l'image réduite et à jour
     975 */
    699976function filtre_fabrique_miniature_image($fichier, $taille=256) {
    700977        $im = filtrer('image_reduire', $fichier, $taille);
  • _plugins_/fabrique/fabrique_options.php

    r60510 r65708  
    11<?php
     2
     3/**
     4 * Options globales chargées à chaque hit
     5 *
     6 * @package SPIP\Fabrique\Options
     7**/
    28
    39if (!defined("_ECRIRE_INC_VERSION")) return;
    410
     11/**
     12 * Version de la structure des données de sauvegarde de la fabrique
     13 * @var int */
    514define('FABRIQUE_VERSION', 5);
    615define('FABRIQUE_ID', 'mom_plugin');
     
    1423// constantes pouvant etre modifiees.
    1524
    16 // espacement des tabulations dans les array tabulaires
    17 // (en nb de caracteres).
    1825if (!defined('_FABRIQUE_ESPACER')) {
     26/**
     27 * Espacement des tabulations dans les array tabulaires
     28 * (en nb de caracteres).
     29 * @var int */
    1930        define('_FABRIQUE_ESPACER', 20);
    2031}
  • _plugins_/fabrique/fabrique_pipelines.php

    r60510 r65708  
    11<?php
    22
     3/**
     4 * Utilisation des pipelines
     5 *
     6 * @package SPIP\Fabrique\Pipelines
     7**/
    38if (!defined('_ECRIRE_INC_VERSION')) return;
    49
    510
     11/**
     12 * Ajout de bulles de compagnon sur la page de création de plugins
     13 * depuis la Fabrique
     14 *
     15 * @param array $flux  Données du pipeline
     16 * @return array       Données du pipeline
     17**/
    618function fabrique_compagnon_messages($flux) {
    719
  • _plugins_/fabrique/saisies/tables_sql_fonctions.php

    r60510 r65708  
    11<?php
    22
     3/**
     4 * Fonctions utiles pour les squelettes de la fabrique
     5 *
     6 * @package SPIP\Fabrique\Fonctions
     7**/
    38if (!defined("_ECRIRE_INC_VERSION")) return;
    49
     
    1520 *
    1621 * @return array
    17  *              Liste des tables.
     22 *     Liste des tables.
    1823**/
    1924function lister_tables_sql() {
Note: See TracChangeset for help on using the changeset viewer.