From 23d1761befc559c2577a43369f8183c7bc29ded2 Mon Sep 17 00:00:00 2001
From: Pierre <pierre@hubert.fr>
Date: Sat, 21 Apr 2018 20:24:05 +0200
Subject: [PATCH] Implemented Survey Object

---
 ...ysController.php => SurveysController.php} | 23 +++++++++-
 RestControllers/postsController.php           |  4 ++
 classes/components/SurveyComponent.php        | 45 +++++++++----------
 3 files changed, 47 insertions(+), 25 deletions(-)
 rename RestControllers/{surveysController.php => SurveysController.php} (79%)

diff --git a/RestControllers/surveysController.php b/RestControllers/SurveysController.php
similarity index 79%
rename from RestControllers/surveysController.php
rename to RestControllers/SurveysController.php
index be79075..a6aee29 100644
--- a/RestControllers/surveysController.php
+++ b/RestControllers/SurveysController.php
@@ -7,7 +7,7 @@
  * @author Pierre HUBERT
  */
 
-class surveysController {
+class SurveysController {
 
 	/**
 	 * Cancel a response to a survey
@@ -87,4 +87,25 @@ class surveysController {
 
 	}
 
+	/**
+	 * Parse a survey object into a valid API entry
+	 * 
+	 * @param Survey $survey The survey object to convert
+	 * @return array Generated API entry
+	 */
+	public static function SurveyToAPI(Survey $survey) : array {
+
+		$data = array();
+
+		$data["ID"] = $survey->get_id();
+		$data["userID"] = $survey->get_userID();
+		$data["postID"] = $survey->get_postID();
+		$data["creation_time"] = $survey->get_time_sent();
+		$data["question"] = $survey->get_question();
+		$data["user_choice"] = $survey->get_user_choice();
+		$data["choices"] = $survey->get_choices();
+
+		return $data;
+	}
+
 }
\ No newline at end of file
diff --git a/RestControllers/postsController.php b/RestControllers/postsController.php
index 008572b..9002873 100644
--- a/RestControllers/postsController.php
+++ b/RestControllers/postsController.php
@@ -528,6 +528,10 @@ class postsController {
 		//Update visibility level
 		$infos['visibility_level'] = $this::VISIBILITY_LEVELS_API[$infos['visibility_level']];
 
+		//Turn survey into API entry (if any)
+		if($infos["data_survey"] != null)
+			$infos["data_survey"] = SurveysController::SurveyToAPI($infos["data_survey"]);
+
 		//Parse comments if required
 		if(isset($infos['comments'])){
 			if($infos['comments'] != null){
diff --git a/classes/components/SurveyComponent.php b/classes/components/SurveyComponent.php
index 48454df..23531ec 100644
--- a/classes/components/SurveyComponent.php
+++ b/classes/components/SurveyComponent.php
@@ -74,24 +74,22 @@ class SurveyComponent {
 	 * Get informations about a survey
 	 * 
 	 * @param int $postID The ID of the post related to the survey
-	 * @return array Informations about the survey / empty array in case of failure
+	 * @return Survey Informations about the survey / invalid Survey in case of failure
 	 */
-	public function get_infos(int $postID) : array {
-
-		$survey = array();
+	public function get_infos(int $postID) : Survey {
 
 		//Get informations about the survey
 		$survey = $this->get_survey_infos($postID);
 
 		//Check for errors
-		if(count($survey) == 0)
-			return array();
+		if(!$survey->isValid())
+			return new Survey();
 
 		//Get the choice of the user
-		$survey['user_choice'] = user_signed_in() ? $this->get_user_choice($survey['ID'], userID) : 0;
+		$survey->set_user_choice(user_signed_in() ? $this->get_user_choice($survey->get_id(), userID) : 0);
 		
 		//Get the choices of the survey
-		$survey['choices'] = $this->get_survey_choices($survey['ID']);
+		$survey->set_choices($this->get_survey_choices($survey->get_id()));
 		
 		return $survey;
 	}
@@ -213,10 +211,10 @@ class SurveyComponent {
 	 * Get survey informations by post ID
 	 * 
 	 * @param int $postID The DI of the related post
-	 * @return array Informations about the survey, or an empty array in case
+	 * @return Survey Information about the survey, or an invalid object in case
 	 * of failure
 	 */
-	private function get_survey_infos(int $postID) : array {
+	private function get_survey_infos(int $postID) : Survey {
 
 		//Fetch the database
 		$conditions = "WHERE ID_texte = ?";
@@ -225,30 +223,29 @@ class SurveyComponent {
 		$result = CS::get()->db->select($this::SURVEY_INFOS_TABLE, $conditions, $condVals);
 		
 		if(count($result) == 0)
-			return array();
+			return new Survey();
 
 		else
-			return $this->parse_survey_infos($result[0]);
+			return $this->dbToSurvey($result[0]);
 	}
 
 	/**
-	 * Parse survey informations from database
+	 * Turn survey entry from the database into Survey object
 	 * 
-	 * @param array $db_infos Informations from the database
-	 * @return array Informations about the post
+	 * @param array $data Data from the database
+	 * @return Survey Generated survey object
 	 */
-	private function parse_survey_infos(array $db_infos) : array {
+	private function dbToSurvey(array $data) : Survey {
 
-		$infos = array();
+		$survey = new Survey();
 
-		//Get informations
-		$infos['ID'] = $db_infos['ID'];
-		$infos['userID'] = $db_infos['ID_utilisateurs'];
-		$infos['postID'] = $db_infos['ID_texte'];
-		$infos['creation_time'] = strtotime($db_infos['date_creation']);
-		$infos['question'] = $db_infos['question'];
+		$survey->set_id($data['ID']);
+		$survey->set_userID($data["ID_utilisateurs"]);
+		$survey->set_postID($data["ID_texte"]);
+		$survey->set_time_sent(strtotime($data['date_creation']));
+		$survey->set_question($data['question']);
 
-		return $infos;
+		return $survey;
 	}
 
 	/**