SMMP/build/api/core/Response.php

124 lines
2.6 KiB
PHP
Raw Permalink Normal View History

2016-07-02 15:10:41 +00:00
<?php
2016-10-18 14:03:03 +00:00
namespace api\core;
2016-10-18 17:09:47 +00:00
use \error\core\Error;
2017-01-30 17:39:21 +00:00
use \error\core\Err;
2017-01-30 17:39:21 +00:00
class Response{
// Attributs prives utiles (initialisation)
private $data;
public $error;
/* CONSTRUCTEUR D'UNE REPONSE DE MODULE
*
* @error<ModuleError> Erreur passee par la requete (si existe)
*
*/
2017-01-30 17:39:21 +00:00
public function __construct($error=null){
if( !( $error instanceof Error ) )
$error = new Error(Err::Success);
2016-07-04 13:45:29 +00:00
$this->data = [];
$this->error = $error;
}
2017-01-30 17:39:21 +00:00
/* AJOUTE UNE DONNEE A LA REPONSE
*
* @key<String> Le nom de la valeur a ajouter
* @value<mixed*> La valeur a ajouter
*
*/
public function append($key, $value){
// Ajoute une entree pour la cle @key et de valeur @value
$this->data[$key] = $value;
return $this;
}
/* AJOUTE TOUTES LES DONNEES A LA REPONSE
*
* @dataset<Array> Le tableau associatif correspondant a la reponse
*
*/
public function appendAll($dataset){
// Si ce n'est pas un tableau, on ne fais rien
2017-01-30 17:39:21 +00:00
if( !is_array($dataset) )
return $this;
// Si une valeur contient une erreur
2017-01-30 17:39:21 +00:00
if( array_key_exists('error', $dataset) && $dataset['error'] instanceof Error){
// On definit cette erreur
2017-01-30 17:39:21 +00:00
$this->error = $dataset['error'];
// On enleve cette entree des donnees
2017-01-30 17:39:21 +00:00
unset($dataset['error']);
}
// Ajoute une entree pour la cle @key et de valeur @value
$this->data = $dataset;
return $this;
}
2017-01-30 17:39:21 +00:00
/* RECUPERE UNE DONNEE DE LA REPONSE
*
* @key<String> Le nom de la valeur a recuperer
*
* @return value<mixed*> La valeur a cette cle
* @return error<null> Retourne NULL si aucune valeur pour cette cle
*
*/
public function get($key){
// Si la valeur de cle @key n'existe pas, on retourne NULL
if( !isset($this->data[$key]) )
return null;
// Sinon, on retourne la valeur associee
return $this->data[$key];
}
/* RECUPERE TOUTES LES DONNEES DE LA REPONSE
*
* @return data<Array> Les donnees de la reponse
*
*/
public function getAll(){
// Sinon, on retourne la valeur associee
return $this->data;
}
/* SERIALISATION A PARTIR DES DONNEES
*
* @return json<String> Retourne les donnees serialisees
*
*/
public function serialize(){
2016-07-02 15:10:41 +00:00
// Code Http
2017-01-30 17:39:21 +00:00
$this->error->setHttpCode();
2016-07-02 15:10:41 +00:00
// Type de contenu
2017-01-30 17:39:21 +00:00
header('Content-Type: application/json; charset=utf-8');
2016-07-02 15:10:41 +00:00
2016-02-08 20:46:11 +00:00
// On rajoute l'erreur au message
2016-07-04 13:45:29 +00:00
$returnData = array_merge([
2017-01-30 17:39:21 +00:00
'error' => $this->error->get(),
'ErrorDescription' => $this->error->explicit(),
'ErrorArguments' => $this->error->args()
2016-07-04 13:45:29 +00:00
],
2016-07-02 15:10:41 +00:00
$this->data
);
return json_encode($returnData);
}
2017-01-30 17:39:21 +00:00
}
2016-07-02 15:10:41 +00:00
?>