Changeset 82256 in spip-zone


Ignore:
Timestamp:
May 7, 2014, 1:04:56 PM (5 years ago)
Author:
tcharlss@…
Message:

PHPDoc : reprendre les commentaires de la branche 2
Administrations : petite coquille

Location:
_plugins_/coordonnees/trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/coordonnees/trunk/coordonnees_administrations.php

    r70504 r82256  
    2121 *     Version du schéma de données dans ce plugin (déclaré dans paquet.xml)
    2222 * @return void
    23 **/
     23 */
    2424function coordonnees_upgrade($nom_meta_base_version, $version_cible) {
    2525        $maj = array();
     
    6767        // mettre les auteurs par defaut comme objet «coordonnable»
    6868        $maj['1.5'] = array(
    69                 array('ecrire_meta','coordonnees', serialize(array('objets'=>array('auteur')))),
     69                array('ecrire_meta','coordonnees', serialize(array('objets'=>array('spip_auteurs')))),
    7070        );
    7171
     
    112112 *     Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
    113113 * @return void
    114 **/
     114 */
    115115function coordonnees_vider_tables($nom_meta_base_version) {
    116116
     
    130130 * Fonction mise a jour du plugin Coordonnees vers 1.3
    131131 * @return void
    132 **/
     132 */
    133133function coordonnees_upgrade_1_3() {
    134134        // On parcourt les adresses pour remplir le code du pays
     
    150150 * Metas : conversion des objets «coordonnables» : on utilise les noms des tables (auteur -> spip_auteurs)
    151151 * @return void
    152 **/
     152 */
    153153function coordonnees_upgrade_1_8_2() {
    154154        include_spip('inc/config');
  • _plugins_/coordonnees/trunk/coordonnees_fonctions.php

    r82252 r82256  
    1313
    1414/**
    15  * Renvoie une seule ou l'ensemble des chaînes de langue des types d'une coordonnée
     15 * Lister l'ensemble des types de liaisons d'une coordonnée, ou la chaîne de langue d'un type de liaison donné.
    1616 *
    17  * Fonction privée mutualisée utilisée par les fonctions ```filtre_coordonnees_lister_types_xxx()```.
    18  * Si on veut tous les types, ignorer le paramètre ```$type``` : la fonction renvoie un tableau contenant les couples types/chaînes de langue de la coordonnée.
     17 * Fonction privée mutualisée utilisée par les fonctions `filtre_coordonnees_lister_types_xxx()`.
     18 * Si on veut tous les types, ignorer le paramètre `$type` : la fonction renvoie un tableau contenant les couples types/chaînes de langue de la coordonnée.
    1919 * Si on veut un seul type en utilisant le paramètre éponyme, elle renvoie la chaîne de langue du type donné.
    2020 *
     
    2727 *
    2828 * @note
    29  * Quand la paramètre ```$type``` n'est pas ```NULL```, mais qu'il est vide,
    30  * ça veut dire qu'on a utilisé ```#TYPE|coordonnees_lister_types_xxx``` avec un ```#TYPE``` vide.
     29 * Quand la paramètre `$type` n'est pas `NULL`, mais qu'il est vide,
     30 * ça veut dire qu'on a utilisé `#TYPE|coordonnees_lister_types_xxx` avec un `#TYPE` vide.
    3131 * Dans ce cas là il ne faut rien retourner.
    3232 *
     
    3636 *     à éviter : adr | tel | mel
    3737 * @param string $type
    38  *     Type dont on veut retourner la chaîne de langue
     38 *     Type de liaison dont on veut retourner la chaîne de langue
    3939 *     A utiliser lorsqu'on ne veut retourner qu'une seule chaîne de langue
    4040 * @return array|int
     
    158158}
    159159
    160 /*
    161  * Renvoie l'icône ou la chaîne de langue d'un type de coordonnée
     160/**
     161 * Affichage du type de liaison d'une coordonnée
    162162 *
    163163 * Fonction privee mutualisée utilisée par les filtres logo_type_xx
    164  * Renvoie soit une balise <img> si l'image est trouvée, soit une balise <abbr>
    165  *
    166  * Nomenclature des fichiers :
    167  *
    168  * - avec le paramètre $coordonnee : `type_{$coordonnee}_{$type}.ext`
     164 *
     165 * @note
     166 * Nomenclature des fichiers d'images :
     167 *
     168 * - avec le paramètre `$coordonnee` : `type_${coordonnee}_${type}.ext`
    169169 *   ex: `type_adresse_home.png`
    170  * - sans le paramètre $coordonnee : `type_{$type}.ext`
     170 * - sans le paramètre `$coordonnee` : `type_${type}.ext`
    171171 *   ex: `type_home.png`
    172  *
     172 *
     173 * @note
     174 * http://www.alsacreations.com/tuto/lire/1222-microformats-design-patterns.html
     175 * http://www.alsacreations.com/tuto/lire/1223-microformats-composes.html
     176 *
    173177 * @param string $coordonnee
    174  *     Coordonnée dont on veut retourner le logo
     178 *     Suffixe du du filtre logo_type_${coordonnee} appelant ;
     179 *     Infixe du logo "type_${coordonnee}_${type}.???" correspondant ;
    175180 *     adresse | numero | email
    176181 *     à éviter : adr | tel | mel
    177182 * @param string $type
    178  *     Le type de coordonnée (dom, home, work etc.)
     183 *     Valeur associée transmise par le filtre logo_type_${coordonnee} ;
     184 *     Suffixe du logo "type_${coordonnee}_${type}.???" correspondant ;
     185 *     Correspond au "type" de liaison de la la coordonnée (home, work, etc.)
    179186 * @return string
    180  *     Balise `<img>` ou `<abbr>`
    181 **/
     187 *     Balise `<IMG>` ou `<ABBR>` (sinon),
     188 *     avec classes semantiques micro-format et traduction des valeurs clés RFC2426
     189 */
    182190function logo_type_($coordonnee='', $type='') {
    183191
     
    227235}
    228236
    229 /*
    230  * Filtre renvoyant une balise `<img>` ou `<abbr>` d'apres le type d'une adresse
     237/**
     238 * Filtre d'affichage du type d'une adresse
    231239 *
    232240 * @uses logo_type_()
    233  *
    234  * @param string $type_adresse    RFC2426/CCITT.X520 : dom home intl parcel postal pref work
    235  * @return string                 Balise `<img>` ou `<abbr>`
    236 **/
     241 * @filtre
     242 *
     243 * @param string $type_adresse
     244 *     Valeur du type de liaison (cf. logo_type_).
     245 *     Les valeurs nativement prises en compte sont les codes normalisés
     246 *     CCITT.X520/RFC2426 (section 3.2.1) : dom home intl parcel postal pref work
     247 * @return string
     248 *     Balise HTML micro-format (cf. logo_type_)
     249 */
    237250function filtre_logo_type_adresse($type_adresse) {
    238251        return logo_type_('adresse', $type_adresse);
    239252}
     253/**
     254 * @deprecated
     255 * @uses filtre_logo_type_adresse()
     256 */
    240257function filtre_logo_type_adr($type_adresse) {
    241         return logo_type_('adresse', $type_adresse);
    242 }
    243 
    244 /*
    245  * Filtre renvoyant une balise <img> ou <abbr> d'apres le type d'un numero de tel
     258        return filtre_logo_type_adresse($type_adresse);
     259}
     260
     261/**
     262 * Filtre d'affichage du type d'un numero
    246263 *
    247264 * @uses logo_type_()
    248  *
    249  * @filtre
    250  * @param string $type_tel    RFC2426/CCITT.X500 : bbs car cell fax home isdn modem msg pager pcs pref video voice work
    251  *                            RFC6350/CCITT.X520.1988 : cell fax pager text textphone video voice x-... (iana-token)
    252  *                            + : dsl
    253  * @return string             Balise `<img>` ou `<abbr>`
    254 **/
     265 * @filtre
     266 *
     267 * @param string $type_numero
     268 *     Valeur du type de liaison (cf. logo_type_).
     269 *     Les valeurs nativement prises en compte sont les codes normalisés
     270 *     CCITT.X500/RFC2426 (section 3.3.1) :      bbs car cell fax home isdn modem msg pager pcs pref video voice work
     271 *     CCITT.X520.1988/RFC6350 (section 6.4.1) : cell fax pager text textphone video voice x-... (iana-token)
     272 *     ainsi que :                               dsl
     273 *     (<http://fr.wikipedia.org/wiki/Digital_Subscriber_Line#Familles>)
     274 * @return string
     275 *     Balise HTML micro-format (cf. logo_type_)
     276 */
    255277function filtre_logo_type_numero($type_numero) {
    256278        return logo_type_('numero', $type_numero);
    257279}
     280/**
     281 * @deprecated
     282 * @uses filtre_logo_type_numero()
     283 */
    258284function filtre_logo_type_tel($type_numero) {
    259         return logo_type_('numero', $type_numero);
    260 }
    261 
    262 /*
    263  * Filtre renvoyant une balise <img> ou <abbr> d'apres le type d'un email
     285        return filtre_logo_type_numero($type_numero);
     286}
     287
     288/**
     289 * Filtre d'affichage du type d'un courriel
    264290 *
    265291 * @uses logo_type_()
    266  *
    267  * @filtre
    268  * @param string $type_adresse    RFC2426/IANA : internet pref x400
    269  * @return string                 Balise `<img>` ou `<abbr>`
     292 * @filtre
     293 *
     294 * @param string $type_email
     295 *     Valeur du type de liaison (cf. logo_type_).
     296 *     Les valeurs nativement prises en compte sont les codes normalisés
     297 *     IANA/RFC2426 (section 3.3.2) :               internet pref x400
     298 *     CCITT.X520+RFC5322/RFC6350 (section 6.4.2) : home (perso) intl work (pro)
     299 * @return string
     300 *     Balise HTML micro-format (cf. logo_type_)
    270301**/
    271302function filtre_logo_type_email($type_email) {
    272303        return logo_type_('email', $type_email);
    273304}
    274 
    275 /*
    276  * Filtre renvoyant une balise <img> ou <abbr> d'apres le type d'un mel (email)
    277  *
    278  * @deprecated Utiliser le filtre logo_type_email() à la place
    279  * @uses logo_type_()
    280  *
    281  * @filtre
    282  * @param string $type_adresse    RFC6350/CCITT.X520+RFC5322 : home (perso) intl work (pro)
    283  * @return string                 Balise `<img>` ou `<abbr>`
    284 **/
     305/**
     306 * @deprecated
     307 * @uses filtre_logo_type_email()
     308 */
    285309function filtre_logo_type_mel($type_email) {
    286         return logo_type_('email', $type_email);
     310        return filtre_logo_type_email($type_email);
    287311}
    288312
Note: See TracChangeset for help on using the changeset viewer.