services/REST/consultations.php

<?php
/**
 * Ce fichier permet de déclarer la classe consultations, ressource exposée à
 * travers l'interface REST qui hérite de la classe de base Services.
 *
 * @package openfoncier
 * @version SVN : $Id$
 */

// Inclusion de la classe de base Services
include_once('./REST/services.php');

// Inclusion de la classe consultationManager qui effectue le traitement métier
include_once('./metier/consultationmanager.php');

/**
 * Cette classe définie la ressource 'consultations' qui permet d'exposer : la
 * saisie d'un retour d'avis sur une consultation par un service interne à la
 * mairie qui souhaite interfacer cette action dans son propre logiciel (ERP).
 */
class consultations extends Services {

    /**
     * Constructeur
     */
    public function __construct() {

        // Appel du constructeur parent
        parent::__construct();

        // Initialisation de l'attribut contents avec les clés qui doivent être
        // récupérées dans les données JSON reçues
        $this->contents['date_retour'] = '';
        $this->contents['avis'] = '';

    }

    /**
     * Destructeur
     */
    public function __destruct() {

        // Appel du destructeur parent
        parent::__destruct();

    }

    /**
     * Cette méthode permet de définir le traitement du PUT sur une requête
     * REST. Elle vérifie la validité du format des données reçues, effectue le
     * traitement et retourne le résultat.
     *
     * @param mixed $request_data Les données JSON reçues (voir @uses)
     * @param string $id L'identifiant de la ressource
     */
    public function put($request_data, $id) {

        // Vérification de l'existence de l'ID de la requête REST
        // Si l'id d'est pas présent, on retourne un code 400
        if (!$id || empty($id)) {
            return $this->sendHttpCode(400, "Aucun id fourni pour la ressource.");
        }

        // Vérification de la validité du format des données de la requête REST
        // Si le format n'est pas correct, on retourne un code 400
        $optional = array('motivation', 'nom_fichier', 'fichier_base64');
        if (!$this->requestValid($request_data, $optional)) {
            return $this->sendHttpCode(400, "Le format des données reçues n'est pas correct.");
        }

        // Instanciation de la classe qui s'occupe du traitement métier
        $this->metier_manager = new ConsultationManager();

        // Exécution du traitement
        $ret = $this->metier_manager->consultationDecision($request_data, $id);

        // Gestion du retour en fonction du résultat
        return $this->sendReply($ret, $this->metier_manager->getMessage());

    }

}

?>
1	mlimic	515	<?php
2	fmichon	744	/**
3			* Ce fichier permet de déclarer la classe consultations, ressource exposée à
4			* travers l'interface REST qui hérite de la classe de base Services.
5	mlimic	523	*
6	fmichon	744	* @package openfoncier
7			* @version SVN : $Id$
8	mlimic	523	*/
9
10	fmichon	744	// Inclusion de la classe de base Services
11			include_once('./REST/services.php');
12	mlimic	523
13	fmichon	744	// Inclusion de la classe consultationManager qui effectue le traitement métier
14			include_once('./metier/consultationmanager.php');
15	mlimic	515
16	fmichon	746	/**
17	fmichon	744	* Cette classe définie la ressource 'consultations' qui permet d'exposer : la
18			* saisie d'un retour d'avis sur une consultation par un service interne à la
19			* mairie qui souhaite interfacer cette action dans son propre logiciel (ERP).
20			*/
21	mlimic	573	class consultations extends Services {
22	mlimic	515
23	fmichon	744	/**
24			* Constructeur
25	mlimic	523	*/
26	mlimic	526	public function __construct() {
27	fmichon	744
28			// Appel du constructeur parent
29	mlimic	515	parent::__construct();
30	fmichon	744
31			// Initialisation de l'attribut contents avec les clés qui doivent être
32			// récupérées dans les données JSON reçues
33	mlimic	515	$this->contents['date_retour'] = '';
34			$this->contents['avis'] = '';
35	fmichon	744
36	mlimic	515	}
37	fmichon	744
38			/**
39			* Destructeur
40	mlimic	523	*/
41	mlimic	526	public function __destruct() {
42	fmichon	744
43			// Appel du destructeur parent
44	mlimic	515	parent::__destruct();
45	fmichon	744
46	mlimic	515	}
47
48	fmichon	744	/**
49			* Cette méthode permet de définir le traitement du PUT sur une requête
50			* REST. Elle vérifie la validité du format des données reçues, effectue le
51			* traitement et retourne le résultat.
52	mlimic	523	*
53	fmichon	744	* @param mixed $request_data Les données JSON reçues (voir @uses)
54			* @param string $id L'identifiant de la ressource
55	mlimic	523	*/
56	mlimic	526	public function put($request_data, $id) {
57	fmichon	744
58			// Vérification de l'existence de l'ID de la requête REST
59			// Si l'id d'est pas présent, on retourne un code 400
60	mlimic	515	if (!$id \|\| empty($id)) {
61	fmichon	744	return $this->sendHttpCode(400, "Aucun id fourni pour la ressource.");
62	mlimic	515	}
63	fmichon	744
64			// Vérification de la validité du format des données de la requête REST
65			// Si le format n'est pas correct, on retourne un code 400
66	mlimic	515	$optional = array('motivation', 'nom_fichier', 'fichier_base64');
67			if (!$this->requestValid($request_data, $optional)) {
68	fmichon	744	return $this->sendHttpCode(400, "Le format des données reçues n'est pas correct.");
69	mlimic	515	}
70	fmichon	744
71			// Instanciation de la classe qui s'occupe du traitement métier
72	mlimic	515	$this->metier_manager = new ConsultationManager();
73	fmichon	744
74			// Exécution du traitement
75	mlimic	559	$ret = $this->metier_manager->consultationDecision($request_data, $id);
76	fmichon	746
77	fmichon	744	// Gestion du retour en fonction du résultat
78	mlimic	718	return $this->sendReply($ret, $this->metier_manager->getMessage());
79	fmichon	744
80	mlimic	515	}
81	fmichon	744
82	mlimic	515	}
83
84			?>