Changeset 96889 in spip-zone


Ignore:
Timestamp:
Apr 30, 2016, 2:12:06 PM (5 years ago)
Author:
eric@…
Message:

Phpdoc et renommage.

Location:
_plugins_/svp_api/trunk
Files:
5 edited

Legend:

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

    r96887 r96889  
    1717 * @api
    1818 *
    19  * @param int $code
     19 * @param int                                       $code
    2020 *      Le code HTTP de l'erreur à générer
     21 * @param Symfony\Component\HttpFoundation\Request  $requete
     22 *      Objet matérialisant la requête faite au serveur SVP.
     23 * @param Symfony\Component\HttpFoundation\Response $reponse
     24 *      Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera
     25 *      complétée avant d'être retourné par la fonction.
    2126 *
    2227 * @return Symfony\Component\HttpFoundation\Response
     
    7176 *      Objet réponse complétée (status, contenu de la ressource...).
    7277 *      La fonction peut lever une erreur sur l'état du serveur, le format de sortie, la collection et sur les critères
    73  *        de filtre à savoir catégorie et compatibilité SPIP.
     78 *      de filtre à savoir catégorie et compatibilité SPIP.
    7479 */
    7580function http_svp_get_collection_dist($requete, $reponse) {
     
    9297                        // Vérification du nom de la collection
    9398                        if (requete_verifier_collection($contenu['requete']['collection'], $erreur)) {
    94                                 $donnees = array();
    9599                                // On vérifie les critères de filtre additionnels si la requête en contient
    96100                                $where = array();
     
    146150 *      Objet réponse complété (status, contenu de la ressource...).
    147151 *      La fonction peut lever une erreur sur l'état du serveur, le format de sortie, le type de ressouce et
    148  *        sur l'existante de la ressource demandée.
     152 *      sur l'existante de la ressource demandée.
    149153 */
    150154function http_svp_get_ressource_dist($requete, $reponse) {
  • _plugins_/svp_api/trunk/inc/svpapi_reponse.php

    r96887 r96889  
    7575 * @return array
    7676 *      Le contenu d'une réponse de l'API SVP est un tableau associatif à 4 entrées:
    77  *      - requete : sous-tableau des éléments de la requête
    78  *      - erreur : sous-tableau des éléments descriptifs d'une erreur (status 200 par défaut)
    79  *      - schema : la version du schéma du plugin SVP hébergé par le serveur
    80  *      - donnees : le tableau des objets demandés fonction de la requête (vide)
     77 *      - `requete` : sous-tableau des éléments de la requête
     78 *      - `erreur` : sous-tableau des éléments descriptifs d'une erreur (status 200 par défaut)
     79 *      - `schema` : la version du schéma du plugin SVP hébergé par le serveur
     80 *      - `donnees` : le tableau des objets demandés fonction de la requête (vide)
    8181 */
    8282function reponse_initialiser_contenu($requete) {
     
    123123 * type PHP simple, entier, chaine ou tableau.
    124124 *
     125 * @uses normaliser_champs()
     126 *
    125127 * @param array $where
    126128 *      Tableau des critères additionnels à appliquer au select.
     
    195197
    196198/**
     199 *
     200 * @uses normaliser_multi()
     201 * @uses denormaliser_version()
     202 *
    197203 * @param string $type_objet
    198204 * @param array  $objet
     205 *
     206 * @uses normaliser_multi()
     207 * @uses denormaliser_version()
    199208 *
    200209 * @return array
     
    266275 * Finalise la réponse à la requête en complétant le header et le contenu mis au préalable
    267276 * au format demandé.
    268  * 
     277 *
    269278 * @param Symfony\Component\HttpFoundation\Response $reponse
     279 *      Objet matérialisant la réponse telle qu'initialisée par le serveur HTTP abstrait. Cet objet sera
     280 *      complétée avant d'être retourné par la fonction.
    270281 * @param array                                     $contenu
    271282 * @param string                                    $format_reponse
  • _plugins_/svp_api/trunk/inc/svpapi_requete.php

    r96887 r96889  
    2121 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    2222 *        Les index mis à jour sont:
    23  *        - status : le code de l'erreur HTTP, soit 501
    24  *        - type : chaine identifiant l'erreur plus précisément, soit serveur_nok
    25  *        - element : type d'objet sur lequel porte l'erreur, soit serveur
    26  *        - valeur : la valeur du mode runtime
    27  *
    28  * @return boolean
    29  *        True si le serveur est valide, false sinon.
     23 *        - `status` : le code de l'erreur HTTP, soit 501
     24 *        - `type`    : chaine identifiant l'erreur plus précisément, soit `serveur_nok`
     25 *        - `element` : type d'objet sur lequel porte l'erreur, soit `serveur`
     26 *        - `valeur` : la valeur du mode runtime
     27 *
     28 * @return boolean
     29 *        `true` si la valeur est valide, `false` sinon.
    3030 */
    3131function requete_verifier_serveur(&$erreur) {
     
    5656 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    5757 *        Les index mis à jour sont:
    58  *        - status : le code de l'erreur HTTP, soit 400
    59  *        - type : chaine identifiant l'erreur plus précisément, soit format_nok
    60  *        - element : type d'objet sur lequel porte l'erreur, soit format
    61  *        - valeur : la valeur du format
    62  *
    63  * @return boolean
    64  *        True si la valeur est valide, false sinon.
     58 *        - `status` : le code de l'erreur HTTP, soit 400
     59 *        - `type`    : chaine identifiant l'erreur plus précisément, soit format_nok
     60 *        - `element` : type d'objet sur lequel porte l'erreur, soit format
     61 *        - `valeur` : la valeur du format
     62 *
     63 * @return boolean
     64 *        `true` si la valeur est valide, `false` sinon.
    6565 */
    6666function requete_verifier_format($valeur, &$erreur) {
     
    9090 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    9191 *        Les index mis à jour sont:
    92  *        - status : le code de l'erreur HTTP, soit 400
    93  *        - type : chaine identifiant l'erreur plus précisément, soit collection_nok
    94  *        - element : type d'objet sur lequel porte l'erreur, soit collection
    95  *        - valeur : la valeur de la collection
    96  *
    97  * @return boolean
    98  *        True si la valeur est valide, false sinon.
     92 *        - `status` : le code de l'erreur HTTP, soit 400
     93 *        - `type`    : chaine identifiant l'erreur plus précisément, soit collection_nok
     94 *        - `element` : type d'objet sur lequel porte l'erreur, soit collection
     95 *        - `valeur` : la valeur de la collection
     96 *
     97 * @return boolean
     98 *        `true` si la valeur est valide, `false` sinon.
    9999 */
    100100function requete_verifier_collection($valeur, &$erreur) {
     
    124124 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    125125 *        Les index mis à jour sont:
    126  *        - status : le code de l'erreur HTTP, soit 400
    127  *        - type : chaine identifiant l'erreur plus précisément, soit ressource_nok
    128  *        - element : type d'objet sur lequel porte l'erreur, soit ressource
    129  *        - valeur : la valeur de la ressource
    130  *
    131  * @return boolean
    132  *        True si la valeur est valide, false sinon.
     126 *        - `status` : le code de l'erreur HTTP, soit 400
     127 *        - `type`    : chaine identifiant l'erreur plus précisément, soit ressource_nok
     128 *        - `element` : type d'objet sur lequel porte l'erreur, soit ressource
     129 *        - `valeur` : la valeur de la ressource
     130 *
     131 * @return boolean
     132 *        `true` si la valeur est valide, `false` sinon.
    133133 */
    134134function requete_verifier_ressource($valeur, &$erreur) {
     
    159159 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    160160 *        Les index mis à jour sont:
    161  *        - status : le code de l'erreur HTTP, soit 400
    162  *        - type : chaine identifiant l'erreur plus précisément, soit prefixe_nok
    163  *        - element : type d'objet sur lequel porte l'erreur, soit prefixe
    164  *        - valeur : la valeur du préfixe
    165  *
    166  * @return boolean
    167  *        True si la valeur est valide, false sinon.
     161 *        - `status` : le code de l'erreur HTTP, soit 400
     162 *        - `type`    : chaine identifiant l'erreur plus précisément, soit prefixe_nok
     163 *        - `element` : type d'objet sur lequel porte l'erreur, soit prefixe
     164 *        - `valeur` : la valeur du préfixe
     165 *
     166 * @return boolean
     167 *        `true` si la valeur est valide, `false` sinon.
    168168 */
    169169function requete_verifier_prefixe($valeur, &$erreur) {
     
    189189 * critère invalide.
    190190 *
     191 * @uses verifier_critere_categorie()
     192 * @uses verifier_critere_compatible_spip()
     193 *
    191194 * @param array $criteres
    192195 *        Tableau associatif des critères (couple nom du critère, valeur du critère)
     
    194197 *        Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur.
    195198 *        Les index mis à jour sont:
    196  *        - status : le code de l'erreur HTTP, soit 400
    197  *        - type : chaine identifiant l'erreur plus précisément, soit critere_nok
    198  *        - element : nom du critère en erreur
    199  *        - valeur : valeur du critère
    200  *
    201  * @return boolean
    202  *        True si la valeur est valide, false sinon.
     199 *        - `status` : le code de l'erreur HTTP, soit 400
     200 *        - `type`    : chaine identifiant l'erreur plus précisément, soit critere_nok
     201 *        - `element` : nom du critère en erreur
     202 *        - `valeur` : valeur du critère
     203 *
     204 * @return boolean
     205 *        `true` si la valeur est valide, `false` sinon.
    203206 */
    204207function requete_verifier_criteres($criteres, &$erreur) {
     
    213216                // On arrête dès qu'une erreur est trouvée et on la reporte
    214217                foreach ($criteres as $_critere => $_valeur) {
    215                         $verifier = "requete_verifier_critere_${_critere}";
     218                        $verifier = "verifier_critere_${_critere}";
    216219                        if (!$verifier($_valeur)) {
    217220                                $erreur = array(
     
    239242 *
    240243 * @return boolean
    241  *        True si la valeur est valide, false sinon.
    242  */
    243 function requete_verifier_critere_categorie($valeur) {
     244 *        `true` si la valeur est valide, `false` sinon.
     245 */
     246function verifier_critere_categorie($valeur) {
    244247        $valide = true;
    245248
     
    262265 *
    263266 * @return boolean
    264  *        True si la valeur est valide, false sinon.
    265  */
    266 function requete_verifier_critere_compatible_spip($valeur) {
     267 *        `true` si la valeur est valide, `false` sinon.
     268 */
     269function verifier_critere_compatible_spip($valeur) {
    267270        $valide = true;
    268271
  • _plugins_/svp_api/trunk/lang/svpapi_fr.php

    r96887 r96889  
    99        // E
    1010        'erreur_400_collection_nok_message' => 'Vous avez demandé une collection qui n\'est pas supportée par ce service. SVP ne fournit que des collections de plugins.',
    11         'erreur_400_collection_nok_titre'   => 'La collection « @valeur@ » n\'est pas fournie par ce service',
     11        'erreur_400_collection_nok_titre'   => 'La collection« « @valeur@ » n\'est pas fournie par ce service',
    1212        'erreur_400_format_nok_message'     => 'Vous avez demandé de renvoyer les données dans un format qui n\'est pas supportée par ce service. SVP n\'utilise que les formats de sortie JSON et XML.',
    1313        'erreur_400_format_nok_titre'       => 'Le format « @valeur@ » n\'est pas supporté par ce service',
  • _plugins_/svp_api/trunk/paquet.xml

    r96887 r96889  
    22        prefix="svpapi"
    33        categorie="outil"
    4         version="0.3.1"
     4        version="0.3.2"
    55        etat="test"
    66        compatibilite="[3.0.0;3.1.*]"
Note: See TracChangeset for help on using the changeset viewer.