Changeset 75195 in spip-zone


Ignore:
Timestamp:
Sep 1, 2013, 11:42:42 AM (6 years ago)
Author:
eric@…
Message:

Renommage d'arguments et PHPDoc

Location:
_plugins_/boussole/trunk
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/boussole/trunk/action/client_retirer_serveur.php

    r75008 r75195  
    77 * par le site client
    88 * *
    9  * @package BOUSSOLE\Client\Action
     9 * @package SPIP\BOUSSOLE\Client\Action
    1010 *
    1111 * @return void
  • _plugins_/boussole/trunk/action/serveur_retirer_boussole.php

    r75124 r75195  
    1717 * des caches pour assurer la cohérence avec la nouvelle configuration.
    1818 *
    19  * @package BOUSSOLE\Serveur\Action
     19 * @package SPIP\BOUSSOLE\Serveur\Action
    2020 *
    2121 * @return void
  • _plugins_/boussole/trunk/inc/client.php

    r75083 r75195  
    77 * Mise à jour en base de données des boussoles installées sur le site client.
    88 *
    9  * @package BOUSSOLE\Client
     9 * @package SPIP\BOUSSOLE\Client
    1010 * @api
    1111 *
     
    3434 * Ajout de la boussole dans la base de donnees du site client
    3535 *
    36  * @package     BOUSSOLE\Client
     36 * @package     SPIP\BOUSSOLE\Client
    3737 * @api
    3838 *
     
    121121 * Suppression de la boussole dans la base de donnees
    122122 *
    123  * @package     BOUSSOLE\Client
     123 * @package     SPIP\BOUSSOLE\Client
    124124 * @api
    125125 *
     
    150150 * Les cles du tableau correspondent au nom des champs en base de donnees
    151151 *
    152  * @package     BOUSSOLE\Client
     152 * @package     SPIP\BOUSSOLE\Client
    153153 *
    154154 * @param string $boussole      Alias de la boussole
  • _plugins_/boussole/trunk/inc/serveur.php

    r75128 r75195  
    1212 * de ces boussoles.
    1313 *
    14  * @package BOUSSOLE\Serveur\Cache
     14 * @package SPIP\BOUSSOLE\Serveur\Cache
    1515 * @api
    1616 *
  • _plugins_/boussole/trunk/inc/simplexml_to_array.php

    r75128 r75195  
    11<?php
     2/**
     3 * 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.
     6 *
     7 * @package SPIP\BOUSSOLE\Outils\XML
     8 *
     9 */
     10
    211
    312if (!defined("_ECRIRE_INC_VERSION")) return;
     
    514
    615/**
    7  * Transforme un texte XML en tableau PHP
     16 * Transformation d'un texte XML ou d'un objet SimpleXML en tableau PHP.
    817 *
    9  * @package SPIP\BOUSSOLE\Outils\XML
     18 * Si l'argument XML est un texte, il est au préalable converti en objet SimpleXML
     19 * par la fonction `simplexml_load_string()`. Ensuite, c'est l'objet *SimpleXML* qui est
     20 * traduit en tableau PHP à partir de la fonction xmlObjToArr()`.
    1021 *
    11  * @param string|object $u
     22 * @uses xmlObjToArr
     23 * @example
     24 *      ```
     25 * $page = recuperer_page($action);
     26 * $convertir = charger_fonction('simplexml_to_array', 'inc');
     27 * $tableau = $convertir(simplexml_load_string($page), false);
     28 *
     29 * ou
     30 *
     31 * $tableau = $convertir($page, false);
     32 *      ```
     33 *
     34 * @param string|object $xml
     35 *              XML à phraser et à transformer en tableau PHP. Le XML peut être fourni :
     36 *
     37 *              - 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.
    1239 * @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.
    1343 * @return array
    1444 */
    15 function inc_simplexml_to_array_dist($u, $utiliser_namespace=false){
     45function inc_simplexml_to_array_dist($xml, $utiliser_namespace=false){
    1646        // decoder la chaine en SimpleXML si pas deja fait
    17         if (is_string($u))
    18                 $u = simplexml_load_string($u);
    19         return array('root'=>@xmlObjToArr($u, $utiliser_namespace));
     47        if (is_string($xml))
     48                $xml = simplexml_load_string($xml);
     49        return array('root'=>@xmlObjToArr($xml, $utiliser_namespace));
    2050}
    2151
    2252
    2353/**
    24  * Transforme un objet SimpleXML en tableau PHP
    25  * http://www.php.net/manual/pt_BR/book.simplexml.php#108688
    26  * xaviered at gmail dot com 17-May-2012 07:00
     54 * Transformation d'un objet SimpleXML en tableau PHP.
    2755 *
    28  * @package BOUSSOLE\Outils
     56 * @link http://www.php.net/manual/pt_BR/book.simplexml.php#108688
     57 * @autor xaviered at gmail dot com 17-May-2012 07:00
    2958 *
    30  * @param object $obj
     59 * @param object $objet_xml
     60 *              Objet SimpleXML à phraser et à transformer en tableau PHP.
    3161 * @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.
    3265 * @return array
    3366**/
    34 function xmlObjToArr($obj, $utiliser_namespace=false) {
     67function xmlObjToArr($objet_xml, $utiliser_namespace=false) {
    3568
    3669        $tableau = array();
     
    3871        // Cette fonction getDocNamespaces() est longue sur de gros xml. On permet donc
    3972        // de l'activer ou pas suivant le contenu supposé du XML
    40         if (is_object($obj)) {
     73        if (is_object($objet_xml)) {
    4174                if (is_array($utiliser_namespace)){
    4275                        $namespace = $utiliser_namespace;
     
    4477                else {
    4578                        if ($utiliser_namespace)
    46                                 $namespace = $obj->getDocNamespaces(true);
     79                                $namespace = $objet_xml->getDocNamespaces(true);
    4780                        $namespace[NULL] = NULL;
    4881                }
    4982
    50                 $name = strtolower((string)$obj->getName());
    51                 $text = trim((string)$obj);
     83                $name = strtolower((string)$objet_xml->getName());
     84                $text = trim((string)$objet_xml);
    5285                if (strlen($text) <= 0) {
    5386                        $text = NULL;
     
    6093                foreach( $namespace as $ns=>$nsUrl ) {
    6194                        // attributes
    62                         $objAttributes = $obj->attributes($ns, true);
     95                        $objAttributes = $objet_xml->attributes($ns, true);
    6396                        foreach( $objAttributes as $attributeName => $attributeValue ) {
    6497                                $attribName = strtolower(trim((string)$attributeName));
     
    71104
    72105                        // children
    73                         $objChildren = $obj->children($ns, true);
     106                        $objChildren = $objet_xml->children($ns, true);
    74107                        foreach( $objChildren as $childName=>$child ) {
    75108                                $childName = strtolower((string)$childName);
Note: See TracChangeset for help on using the changeset viewer.