Changeset 96889 in spip-zone
- Timestamp:
- Apr 30, 2016, 2:12:06 PM (5 years ago)
- Location:
- _plugins_/svp_api/trunk
- Files:
-
- 5 edited
-
http/svp.php (modified) (4 diffs)
-
inc/svpapi_reponse.php (modified) (4 diffs)
-
inc/svpapi_requete.php (modified) (10 diffs)
-
lang/svpapi_fr.php (modified) (1 diff)
-
paquet.xml (modified) (1 diff)
Legend:
- Unmodified
- Added
- Removed
-
_plugins_/svp_api/trunk/http/svp.php
r96887 r96889 17 17 * @api 18 18 * 19 * @param int $code19 * @param int $code 20 20 * 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. 21 26 * 22 27 * @return Symfony\Component\HttpFoundation\Response … … 71 76 * Objet réponse complétée (status, contenu de la ressource...). 72 77 * La fonction peut lever une erreur sur l'état du serveur, le format de sortie, la collection et sur les critères 73 * 78 * de filtre à savoir catégorie et compatibilité SPIP. 74 79 */ 75 80 function http_svp_get_collection_dist($requete, $reponse) { … … 92 97 // Vérification du nom de la collection 93 98 if (requete_verifier_collection($contenu['requete']['collection'], $erreur)) { 94 $donnees = array();95 99 // On vérifie les critères de filtre additionnels si la requête en contient 96 100 $where = array(); … … 146 150 * Objet réponse complété (status, contenu de la ressource...). 147 151 * La fonction peut lever une erreur sur l'état du serveur, le format de sortie, le type de ressouce et 148 * 152 * sur l'existante de la ressource demandée. 149 153 */ 150 154 function http_svp_get_ressource_dist($requete, $reponse) { -
_plugins_/svp_api/trunk/inc/svpapi_reponse.php
r96887 r96889 75 75 * @return array 76 76 * 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ête78 * - 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 serveur80 * - 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) 81 81 */ 82 82 function reponse_initialiser_contenu($requete) { … … 123 123 * type PHP simple, entier, chaine ou tableau. 124 124 * 125 * @uses normaliser_champs() 126 * 125 127 * @param array $where 126 128 * Tableau des critères additionnels à appliquer au select. … … 195 197 196 198 /** 199 * 200 * @uses normaliser_multi() 201 * @uses denormaliser_version() 202 * 197 203 * @param string $type_objet 198 204 * @param array $objet 205 * 206 * @uses normaliser_multi() 207 * @uses denormaliser_version() 199 208 * 200 209 * @return array … … 266 275 * Finalise la réponse à la requête en complétant le header et le contenu mis au préalable 267 276 * au format demandé. 268 * 277 * 269 278 * @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. 270 281 * @param array $contenu 271 282 * @param string $format_reponse -
_plugins_/svp_api/trunk/inc/svpapi_requete.php
r96887 r96889 21 21 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 22 22 * Les index mis à jour sont: 23 * - status: le code de l'erreur HTTP, soit 50124 * - type : chaine identifiant l'erreur plus précisément, soit serveur_nok25 * - element : type d'objet sur lequel porte l'erreur, soit serveur26 * - valeur: la valeur du mode runtime27 * 28 * @return boolean 29 * True si le serveur est valide, falsesinon.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. 30 30 */ 31 31 function requete_verifier_serveur(&$erreur) { … … 56 56 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 57 57 * Les index mis à jour sont: 58 * - status: le code de l'erreur HTTP, soit 40059 * - type: chaine identifiant l'erreur plus précisément, soit format_nok60 * - element: type d'objet sur lequel porte l'erreur, soit format61 * - valeur: la valeur du format62 * 63 * @return boolean 64 * True si la valeur est valide, falsesinon.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. 65 65 */ 66 66 function requete_verifier_format($valeur, &$erreur) { … … 90 90 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 91 91 * Les index mis à jour sont: 92 * - status: le code de l'erreur HTTP, soit 40093 * - type: chaine identifiant l'erreur plus précisément, soit collection_nok94 * - element: type d'objet sur lequel porte l'erreur, soit collection95 * - valeur: la valeur de la collection96 * 97 * @return boolean 98 * True si la valeur est valide, falsesinon.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. 99 99 */ 100 100 function requete_verifier_collection($valeur, &$erreur) { … … 124 124 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 125 125 * Les index mis à jour sont: 126 * - status: le code de l'erreur HTTP, soit 400127 * - type: chaine identifiant l'erreur plus précisément, soit ressource_nok128 * - element: type d'objet sur lequel porte l'erreur, soit ressource129 * - valeur: la valeur de la ressource130 * 131 * @return boolean 132 * True si la valeur est valide, falsesinon.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. 133 133 */ 134 134 function requete_verifier_ressource($valeur, &$erreur) { … … 159 159 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 160 160 * Les index mis à jour sont: 161 * - status: le code de l'erreur HTTP, soit 400162 * - type: chaine identifiant l'erreur plus précisément, soit prefixe_nok163 * - element: type d'objet sur lequel porte l'erreur, soit prefixe164 * - valeur: la valeur du préfixe165 * 166 * @return boolean 167 * True si la valeur est valide, falsesinon.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. 168 168 */ 169 169 function requete_verifier_prefixe($valeur, &$erreur) { … … 189 189 * critère invalide. 190 190 * 191 * @uses verifier_critere_categorie() 192 * @uses verifier_critere_compatible_spip() 193 * 191 194 * @param array $criteres 192 195 * Tableau associatif des critères (couple nom du critère, valeur du critère) … … 194 197 * Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. 195 198 * Les index mis à jour sont: 196 * - status: le code de l'erreur HTTP, soit 400197 * - type: chaine identifiant l'erreur plus précisément, soit critere_nok198 * - element: nom du critère en erreur199 * - valeur: valeur du critère200 * 201 * @return boolean 202 * True si la valeur est valide, falsesinon.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. 203 206 */ 204 207 function requete_verifier_criteres($criteres, &$erreur) { … … 213 216 // On arrête dès qu'une erreur est trouvée et on la reporte 214 217 foreach ($criteres as $_critere => $_valeur) { 215 $verifier = " requete_verifier_critere_${_critere}";218 $verifier = "verifier_critere_${_critere}"; 216 219 if (!$verifier($_valeur)) { 217 220 $erreur = array( … … 239 242 * 240 243 * @return boolean 241 * True si la valeur est valide, falsesinon.242 */ 243 function requete_verifier_critere_categorie($valeur) {244 * `true` si la valeur est valide, `false` sinon. 245 */ 246 function verifier_critere_categorie($valeur) { 244 247 $valide = true; 245 248 … … 262 265 * 263 266 * @return boolean 264 * True si la valeur est valide, falsesinon.265 */ 266 function requete_verifier_critere_compatible_spip($valeur) {267 * `true` si la valeur est valide, `false` sinon. 268 */ 269 function verifier_critere_compatible_spip($valeur) { 267 270 $valide = true; 268 271 -
_plugins_/svp_api/trunk/lang/svpapi_fr.php
r96887 r96889 9 9 // E 10 10 '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', 12 12 '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.', 13 13 'erreur_400_format_nok_titre' => 'Le format « @valeur@ » n\'est pas supporté par ce service', -
_plugins_/svp_api/trunk/paquet.xml
r96887 r96889 2 2 prefix="svpapi" 3 3 categorie="outil" 4 version="0.3. 1"4 version="0.3.2" 5 5 etat="test" 6 6 compatibilite="[3.0.0;3.1.*]"
Note: See TracChangeset
for help on using the changeset viewer.
