Changeset 75196 in spip-zone


Ignore:
Timestamp:
Sep 1, 2013, 12:57:47 PM (6 years ago)
Author:
eric@…
Message:

Encore du PHPDoc

Location:
_plugins_/boussole/trunk/inc
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/inc/informer_plugin.php

    r75128 r75196  
    11<?php
     2/**
     3 * Ce fichier contient la fonction surchargeable de récupération des informations d'un plugin.
     4 *
     5 * @package SPIP\BOUSSOLE\Outils\Plugins
     6 */
    27
    38if (!defined("_ECRIRE_INC_VERSION")) return;
     
    611/**
    712 * Récupération des informations d'un plugin connu par son préfixe.
     13 *
    814 * Cette fonction reloade systématiquement le cache des plugins afin d'être sur
    9  * de lire les informations à jour
     15 * de lire les informations à jour.
    1016 *
    11  * @package     SPIP\BOUSSOLE\Outils
     17 * @todo
     18 *              Elle pourrait être avantageusement remplacé par le filtre SPIP info_plugin() si
     19 *              celui-ci pouvait forcer la relecture du XML (ajout d'un argument reload suffirait).
    1220 *
    1321 * @param $prefixe
    14  *
     22 *              Préfixe du plugin en minuscules.
    1523 * @return array
     24 *              Tableau de toutes les informations du plugin ou tableau vide en cas d'erreur.
    1625 */
    1726function inc_informer_plugin_dist($prefixe) {
  • _plugins_/boussole/trunk/inc/simplexml_to_array.php

    r75195 r75196  
    22/**
    33 * Ce fichier contient la fonction surchargeable de transformation d'un XML en tableau PHP.
    4  * Cette fonction est une réplication de la fonction identique de SPIP. Elle est dupliquée
    5  * pour pallier au fait que la fonction SPIP n'est dispobible qu'à partir de SPIP 3.0.10.
     4 * Cette fonction est une réplication de la fonction homonyme de SPIP. Elle est dupliquée
     5 * dans le plugin car la fonction SPIP n'est disponible qu'à partir de la version 3.0.10.
    66 *
    77 * @package SPIP\BOUSSOLE\Outils\XML
    8  *
    98 */
    109
     
    1413
    1514/**
    16  * Transformation d'un texte XML ou d'un objet SimpleXML en tableau PHP.
     15 * Transformation d'un texte XML ou d'un objet *SimpleXML* en tableau PHP.
    1716 *
    18  * Si l'argument XML est un texte, il est au préalable converti en objet SimpleXML
     17 * Si l'argument XML est un texte, il est au préalable converti en objet *SimpleXML*
    1918 * par la fonction `simplexml_load_string()`. Ensuite, c'est l'objet *SimpleXML* qui est
    20  * traduit en tableau PHP à partir de la fonction xmlObjToArr()`.
     19 * traduit en tableau PHP à partir de la fonction `xmlObjToArr()`.
    2120 *
    22  * @uses xmlObjToArr
     21 * @uses xmlObjToArr()
    2322 * @example
    2423 *      ```
     
    3635 *
    3736 *              - soit comme une chaine de caractères représentant le texte XML lui-même,
    38  *              - soit comme un objet XML produit par la fonction simplexml_load_string() de PHP.
     37 *              - soit comme un objet XML produit à partir du texte par la fonction
     38 *              `simplexml_load_string()` de PHP.
    3939 * @param bool $utiliser_namespace
    40  *              Indicateur d'utilisation des namespaces dans le XML. Si aucun namespace est
    41  *              utilisé, il est plus performant de mettre l'argument à `false afin
    42  *              d'éviter l'appel à la fonction getDocNamespaces()` qui peut-être lourd.
     40 *              Indicateur d'utilisation des namespaces dans le XML. Si aucun namespace n'est
     41 *              utilisé dans le XML, il est préférable de forcer l'argument à `false` afin
     42 *              d'éviter l'appel à la fonction `getDocNamespaces()`.
    4343 * @return array
    4444 */
    4545function inc_simplexml_to_array_dist($xml, $utiliser_namespace=false){
    46         // decoder la chaine en SimpleXML si pas deja fait
     46        // coder la chaine en SimpleXML si pas deja fait
    4747        if (is_string($xml))
    4848                $xml = simplexml_load_string($xml);
     
    5252
    5353/**
    54  * Transformation d'un objet SimpleXML en tableau PHP.
     54 * Transformation d'un objet *SimpleXML* en tableau PHP.
    5555 *
    56  * @link http://www.php.net/manual/pt_BR/book.simplexml.php#108688
    5756 * @autor xaviered at gmail dot com 17-May-2012 07:00
    5857 *
    5958 * @param object $objet_xml
    60  *              Objet SimpleXML à phraser et à transformer en tableau PHP.
     59 *              Objet *SimpleXML* à phraser et à transformer en tableau PHP.
    6160 * @param bool $utiliser_namespace
    62  *              Indicateur d'utilisation des namespaces dans le XML. Si aucun namespace est
    63  *              utilisé, il est plus performant de mettre l'argument à `false afin
    64  *              d'éviter l'appel à la fonction getDocNamespaces()` qui peut-être lourd.
     61 *              Indicateur d'utilisation des namespaces dans le XML. Si aucun namespace n'est
     62 *              utilisé dans le XML, il est préférable de forcer l'argument à `false` afin
     63 *              d'éviter l'appel à la fonction getDocNamespaces()`.
    6564 * @return array
    6665**/
Note: See TracChangeset for help on using the changeset viewer.