Changeset 96842 in spip-zone


Ignore:
Timestamp:
Apr 27, 2016, 7:30:15 PM (3 years ago)
Author:
eric@…
Message:

Phpdoc.
Permet en particulier de nommer les objets request et response et d'éviter les warnings de l'ide.

Location:
_plugins_/svp_api/trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/svp_api/trunk/http/svp.php

    r96818 r96842  
    5656 * compatibilité SPIP.
    5757 *
    58  * @param object $requete
     58 * @param Symfony\Component\HttpFoundation\Request $requete
    5959 *        Objet matérialisant la requête faite au serveur SVP.
    60  * @param object $reponse
     60 * @param Symfony\Component\HttpFoundation\Response $reponse
    6161 *        Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera
    6262 *        complétée avant d'être retourné par la fonction.
     
    125125 * Fait un GET sur une ressource de type plugin identifié par son préfixe.
    126126 *
    127  * @param object $requete
     127 * @param Symfony\Component\HttpFoundation\Request $requete
    128128 *        Objet matérialisant la requête faite au serveur SVP.
    129  * @param object $reponse
     129 * @param Symfony\Component\HttpFoundation\Response $reponse
    130130 *        Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera
    131131 *        complétée avant d'être retourné par la fonction.
  • _plugins_/svp_api/trunk/inc/svpapi_reponse.php

    r96818 r96842  
    55
    66if (!defined('_SVPAPI_CHAMPS_MULTI_PLUGIN')) {
     7        /**
     8         *
     9         */
    710        define('_SVPAPI_CHAMPS_MULTI_PLUGIN', 'nom,slogan');
    811}
    912if (!defined('_SVPAPI_CHAMPS_SERIALISES_PLUGIN')) {
     13        /**
     14         *
     15         */
    1016        define('_SVPAPI_CHAMPS_SERIALISES_PLUGIN', '');
    1117}
    1218
    1319if (!defined('_SVPAPI_CHAMPS_MULTI_PAQUET')) {
     20        /**
     21         *
     22         */
    1423        define('_SVPAPI_CHAMPS_MULTI_PAQUET', 'description');
    1524}
    1625if (!defined('_SVPAPI_CHAMPS_SERIALISES_PAQUET')) {
     26        /**
     27         *
     28         */
    1729        define('_SVPAPI_CHAMPS_SERIALISES_PAQUET', 'auteur,credit,licence,copyright,dependances,procure,traductions');
    1830}
    1931
    2032/**
    21  * @param $requete
     33 * @param Symfony\Component\HttpFoundation\Request      $requete
    2234 *
    2335 * @return array
     
    5769
    5870
     71/**
     72 * @param array $where
     73 *
     74 * @return array
     75 */
    5976function reponse_collectionner_plugins($where) {
    6077
     
    86103
    87104
     105/**
     106 * @param array $where
     107 *
     108 * @return array
     109 */
    88110function reponse_collectionner_depots($where) {
    89111
     
    110132
    111133
     134/**
     135 * @param string        $type_objet
     136 * @param array         $objet
     137 *
     138 * @return array
     139 */
    112140function normaliser_champs($type_objet, $objet) {
    113141
     
    135163
    136164/**
    137  * @param $erreur
    138  *
    139  * @return mixed
     165 * @param array $erreur
     166 *
     167 * @return array
    140168 */
    141169function reponse_expliquer_erreur($erreur) {
     
    155183
    156184/**
    157  * @param $reponse
    158  * @param $contenu
     185 * @param Symfony\Component\HttpFoundation\Response     $reponse
     186 * @param array                                                                         $contenu
     187 * @param string                                                                        $format_reponse
    159188 *
    160189 * @return mixed
  • _plugins_/svp_api/trunk/inc/svpapi_requete.php

    r96819 r96842  
    1010 * @param string        $valeur
    1111 *              La valeur du format de sortie
    12  * @param array         $erreur
     12 * @param &array        $erreur
     13 *              Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
     14 *      Les index mis à jour sont:
     15 *      - status : le code de l'erreur HTTP, soit 400
     16 *      - type : chaine identifiant l'erreur plus précisément, soit format_nok
     17 *      - element : type d'objet sur lequel porte l'erreur, soit format
     18 *      - valeur : la valeur du format
    1319 *
    1420 * @return boolean
     
    3743 * @param string $valeur
    3844 *              La valeur de la collection demandée
     45 * @param &array        $erreur
     46 *              Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
     47 *      Les index mis à jour sont:
     48 *      - status : le code de l'erreur HTTP, soit 400
     49 *      - type : chaine identifiant l'erreur plus précisément, soit collection_nok
     50 *      - element : type d'objet sur lequel porte l'erreur, soit collection
     51 *      - valeur : la valeur de la collection
    3952 *
    4053 * @return boolean
     
    6376 * @param string $valeur
    6477 *              La valeur de la collection demandée
     78 * @param &array        $erreur
     79 *              Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
     80 *      Les index mis à jour sont:
     81 *      - status : le code de l'erreur HTTP, soit 400
     82 *      - type : chaine identifiant l'erreur plus précisément, soit ressource_nok
     83 *      - element : type d'objet sur lequel porte l'erreur, soit ressource
     84 *      - valeur : la valeur de la ressource
    6585 *
    6686 * @return boolean
     
    90110 * @param string $valeur
    91111 *              La valeur du préfixe
     112 * @param &array        $erreur
     113 *              Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
     114 *      Les index mis à jour sont:
     115 *      - status : le code de l'erreur HTTP, soit 400
     116 *      - type : chaine identifiant l'erreur plus précisément, soit prefixe_nok
     117 *      - element : type d'objet sur lequel porte l'erreur, soit prefixe
     118 *      - valeur : la valeur du préfixe
    92119 *
    93120 * @return boolean
     
    110137
    111138
     139/**
     140 * Détermine si la valeur de chaque critère est valide.
     141 * Si plusieurs critères sont fournis, la fonction s'interromp dès qu'elle trouve un
     142 * critère invalide.
     143 *
     144 * @param array $criteres
     145 *              Tableau associatif des critères (couple nom du critère, valeur du critère)
     146 * @param &array        $erreur
     147 *              Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
     148 *      Les index mis à jour sont:
     149 *      - status : le code de l'erreur HTTP, soit 400
     150 *      - type : chaine identifiant l'erreur plus précisément, soit critere_nok
     151 *      - element : nom du critère en erreur
     152 *      - valeur : valeur du critère
     153 *
     154 * @return boolean
     155 *              True si la valeur est valide, false sinon.
     156 */
    112157function requete_verifier_criteres($criteres, &$erreur) {
    113158
Note: See TracChangeset for help on using the changeset viewer.