Swagnimations n comments

.gitignore

@@ -2,3 +2,5 @@
 .*.swp
 
 test*
+
+*~

web/api/model/class.categorie.php

@@ -1,18 +1,40 @@
 <?php
 
+/*******************************************************************************
+* Classe Categorie																														 *
+*	Auteur : Brendan Abolivier																									 *
+* Fonction : Créer un objet représentatif d'une catégorie											 *
+*																																							 *
+*	Attribut :																																	 *
+*		$bdd : Connector																												   *
+*		$nomCat : String																												 	 *
+*		$questsets : Array (Questset)																							 *
+*																																							 *
+* Méthodes :																																	 *
+*		__construct()																															 *
+*		randSelect() [statique]																										 *
+*		getArray()																																 *
+*******************************************************************************/
 class Categorie {
 	private $bdd;
 	private $nomCat;
 	private $questsets;
 
+	/*****************************************************************************
+	* Méthode __construct()                                                      *
+	*	Fonction : Constructeur, crée un objet Categorie à partir de son nom			 *
+	*																																						 *
+	*	Paramètres :																															 *
+	*		$nomCat (String) : Nom de la catégorie																	 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*																																						 *
+	*	Exceptions :																															 *
+	*		cant_find_cat : La catégorie est introuvable dans la base de données		 *
+	*****************************************************************************/
 	function __construct($nomCat) {
 		$this->bdd = new Connector();
-		$this->selectCat($nomCat);
-		$this->questsets = array();
-		$this->load();
-	}
 
-	private function selectCat($nomCat) {
 		$options = array(
 			"where" => array(
 				array("nom_cat", "=", $nomCat)
@@ -24,9 +46,9 @@ class Categorie {
 		} else {
 			throw new Exception('cant_find_cat');
 		}
-	}
 
-	private function load() {
+		$this->questsets = array();
+
 		$options = array(
 			"where" => array(
 				array("nom_cat", "=", $this->nomCat)
@@ -37,10 +59,22 @@ class Categorie {
 
 		$resp = $this->bdd->Select('*', 'reponses', $options);
 		foreach($resp as $questset) {
-			array_push($this->questsets, new Questset(array($questset['reponse1'], $questset['reponse2'])));
+			array_push($this->questsets, new Questset(array($questset['reponse1'],
+																											$questset['reponse2'])));
 		}
 	}
 
+	/*****************************************************************************
+	* Méthode randSelect() [statique]                                            *
+	*	Fonction : Sélectionne aléatoirement deux catégories valides (au moins 		 *
+	*						 deux thèmes avec chacun au moins trois questions)			 				 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	*	Retour :																																	 *
+	*		Tableau contenant deux objets Categorie valides, sélectionnés						 *
+	*			aléatoirement																													 *
+	*****************************************************************************/
 	public static function randSelect() {
 		$bdd = new Connector();
 		$options = array(
@@ -50,6 +84,7 @@ class Categorie {
 		$return = array();
 		$catIndex = -1;
 		$previousIndex = -1;
+		// On retire du tableau les catégories invalides
 		for($i = 0; $i < sizeof($arrayCat); $i++) {
 			$category = new Categorie($arrayCat[$i]['nom_cat']);
 			if(sizeof($category->getArray()['themes']) >=2) {
@@ -62,6 +97,7 @@ class Categorie {
 				array_splice($arrayCat, $i, 1);
 			}
 		}
+		// On sélectionne deux catégories dans celles restantes
 		for($i = 0; $i < 2; $i++) {
 			array_push($return, new Categorie($arrayCat[$i]['nom_cat']));
 		}
@@ -69,6 +105,16 @@ class Categorie {
 		return $return;
 	}
 
+	/*****************************************************************************
+	* Méthode getArray()						                                             *
+	*	Fonction : Renvoie un tableau représentant la catégorie courante	 				 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	*	Retour :																																	 *
+	*		Tableau contenant le nom de la catégorie, ainsi qu'un tableau des thèmes *
+	*			inclus dans cette dernière (méthode getArray() de la classe Questset)	 *
+	*****************************************************************************/
 	public function getArray() {
 		$questsets = array();
 		foreach($this->questsets as $questset) {

web/api/model/class.connector.php

@@ -1,9 +1,34 @@
 <?php
 
+/*******************************************************************************
+* Classe Connector																														 *
+*	Auteur : Brendan Abolivier																									 *
+* Fonction : Permettre une gestion plus facile et plus claire de la connexion  *
+*						 au serveur MySQL																									 *
+*																																							 *
+*	Attribut :																																	 *
+*		$bdd : objet PDO																													 *
+*																																							 *
+* Méthodes :																																	 *
+*		__construct()																															 *
+*		Select()																																	 *
+*		Insert()																																	 *
+*		Update()																																	 *
+*******************************************************************************/
 class Connector {
 
 	private $bdd;
 
+	/*****************************************************************************
+	* Méthode __construct()                                                      *
+	*	Fonction : Constructeur, initie la connexion à la base de données via PDO, *
+	*					   en utilisant les paramètres définis dans le fichier params.cfg  *
+	*						 par l'utilisateur                                               *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*****************************************************************************/
 	function __construct() {
 		$params = file_get_contents("../params.cfg");
 		preg_match_all('/db_(.+)\: (.+)/', $params, $matches);
@@ -12,22 +37,46 @@ class Connector {
 			$dbconnect[$matches[1][$i]] = $matches[2][$i];
 		}
 
-		$this->bdd = new PDO("mysql:host=".$dbconnect["host"].";dbname=".$dbconnect["dbname"], $dbconnect["user"], $dbconnect["pass"]);
+		$this->bdd = new PDO("mysql:host=".$dbconnect["host"].";dbname="
+								.$dbconnect["dbname"], $dbconnect["user"], $dbconnect["pass"]);
 		$this->bdd->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 	}
 
-	/*
-		Exemple de $options :
-
-		$options = array(
-			"where" => array(
-				array("foo", "=", "bar"),
-				array("blbl", ">", 5)
-			),
-			"order by" => array("foo", "desc"),
-			"limit" => array(0, 10) // Ou array(10)
-		);
-	*/
+	/*****************************************************************************
+	*	Méthode Select()																													 *
+	*	Fonction : Effectue une insertion dans la base de données									 *
+	*																																						 *
+	* Paramètres :																															 *
+	* 	$fields (String) : Champs à sélectionner, séparés par une virgule				 *
+	*		$tables (String) : Tables dans lesquelles effectuer les champs, séparées *
+	*											 par une virgule																			 *
+	*		$options (Array (mixed)) : Tableau contenant les différentes clauses de  *
+	*		 (mixed : Array, String) | la requête.																	 *
+	*															 Exemple de tableau :													 *
+	*																$options = array(														 *
+	*																	"where" => array(													 *
+	*																		array("foo", "=", "bar"),								 *
+	*																		array("blbl", ">", 5)										 *
+	*																	),																				 *
+	*																	"order by" => array("foo", "desc"),				 *
+	*																	"limit" => array(0, 10) // Ou array(10)		 *
+	*																);																					 *
+	*											 Si cet argument n'est pas passé, la méthode s'exécute *
+	*											 avec un tableau vide.																 *
+	*																																						 *
+	*	Retour :																																	 *
+	*		Tableau contenant les résultats renvoyés par la base de données					 *
+	*		null si la requête a renvoyé un ensemble vide														 *
+	*																																						 *
+	*	Exceptions :																															 *
+	*		wrong_arg_nmbr_where : Nombre d'arguments insuffisant sur une partie de  *
+	*													 la clause WHERE																	 *
+	*		wrong_arg_nmbr_order_by : Nombre d'arguments insuffisant sur la clause   *
+	*															ORDER BY																			 *
+	*		wrong_arg_numbr_limit : Nombre d'arguments insuffisant sur la clause     *
+	*														LIMIT                                            *
+	*		unknown_arg : Le tableau contient une clause inconnue ou non supportée   *
+	*****************************************************************************/
 	function Select($fields, $tables, $options = array()) {
 		$request = "SELECT $fields FROM $tables ";
 		$arrayVerif = array();
@@ -76,6 +125,17 @@ class Connector {
 		}
 	}
 
+	/*****************************************************************************
+	*	Méthode Insert()																													 *
+	*	Fonction : Effectue une insertion dans la base de données									 *
+	*																																						 *
+	*	Paramètres :																															 *
+	* 	$table (String) : Table dans laquelle effectuer l'insertion							 *
+	*		$values (Array (String)) : Valeurs à insérer dans la table (tableau   	 *
+	*															 associatif)																	 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*****************************************************************************/
 	function Insert($table, $values) {
 		$request = "INSERT INTO $table(";
 		$valeurs = "VALUES(";
@@ -93,6 +153,17 @@ class Connector {
 		$stmt->execute($arrayVerif);
 	}
 
+	/*****************************************************************************
+	*	Méthode Update()																													 *
+	*	Fonction : Modifie une ou plusieurs valeur(s) dans la base de données			 *
+	*																																						 *
+	*	Paramètres :																															 *
+	* 	$table (String) : Table dans laquelle effectuer la mise à jour					 *
+	*		$update (Array (mixed)) : Tableau contenant la (ou les)	valeur(s) à	  	 *
+	*  	 (mixed : Array, String)| modifier et la clause WHERE correspondante		 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*****************************************************************************/
 	function Update($table, $update) {
 		$request = "UPDATE $table SET ";
 		$arrayVerif = array();
@@ -111,10 +182,27 @@ class Connector {
 		$stmt->execute($arrayVerif);
 	}
 
+	/*****************************************************************************
+	*	Méthode beginTransaction()																								 *
+	*	Fonction : Initie une transaction MySQL																		 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	* Retour : Aucun																														 *
+	*****************************************************************************/
 	function beginTransaction() {
 		$this->bdd->beginTransaction();
 	}
 
+	/*****************************************************************************
+	*	Méthode commit()																								 					 *
+	*	Fonction : Publie les modifications sur le serveur MySQL et ferme la			 *
+	*						 transaction en cours																						 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	* Retour : Aucun																														 *
+	*****************************************************************************/
 	function commit() {
 		$this->bdd->commit();
 	}

web/api/model/class.question.php

@@ -1,11 +1,35 @@
 <?php
 
+/*******************************************************************************
+* Classe Question																														 *
+*	Auteur : Brendan Abolivier																									 *
+* Fonction : Créer un objet représentatif d'une question											 *
+*																																							 *
+*	Attribut :																																	 *
+*		$reponse1 : String																												 *
+*		$reponse2 : String																												 *
+*		$intitule : String																												 *
+*		$bonneReponse : Int																												 *
+*																																							 *
+* Méthodes :																																	 *
+*		__construct()																															 *
+*		getArray()																																 *
+*******************************************************************************/
 class Question {
 	private $reponse1;
 	private $reponse2;
 	private $intitule;
 	private $bonneReponse;
 
+	/*****************************************************************************
+	* Méthode __construct()                                                      *
+	*	Fonction : Constructeur, crée un objet Question à partir de son intitule   *
+	*																																						 *
+	*	Paramètres :																															 *
+	*		$intitule (String) : Intitulé de la question														 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*****************************************************************************/
 	function __construct($intitule) {
 		try{
 			$this->intitule = $intitule;
@@ -21,28 +45,23 @@ class Question {
 
 			$this->reponse1 = $question[0]['reponse1'];
 			$this->reponse2 = $question[0]['reponse2'];
-			
+
 			$this->bonneReponse = $question[0]['num_reponse'];
 		} catch(Exception $e) {
 			throw $e;
 		}
 	}
 
-	function getIntitule() {
-		return $this->intitule;
-	}
-
-	function getReponses() {
-		return array(
-			"reponse1" => $this->reponse1,
-			"reponse2" => $this->reponse2
-		);
-	}
-
-	function getBonneReponse() {
-		return $this->bonneReponse;
-	}
-
+	/*****************************************************************************
+	* Méthode getArray()                                               		       *
+	*	Fonction : Renvoie un tableau associatif représentant l'objet courant  		 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	*	Retour :																														 			 *
+	*		Tableau contenant l'intulé et un entier symbolisant la bonne réponse de	 *
+	*			la question																														 *
+	*****************************************************************************/
 	function getArray() {
 		return array(
 			"intitule" => utf8_encode($this->intitule),

web/api/model/class.questset.php

@@ -1,10 +1,38 @@
 <?php
 
+/*******************************************************************************
+* Classe Questset																														 *
+*	Auteur : Brendan Abolivier																									 *
+* Fonction : Créer un objet représentatif d'un jeu de questions (thème)				 *
+*																																							 *
+*	Attribut :																																	 *
+*		$reponse1 : String																												 *
+*		$reponse2 : String																												 *
+*		$questions : Array (Question)																							 *
+*																																							 *
+* Méthodes :																																	 *
+*		__construct()																															 *
+*		getArray()																																 *
+*******************************************************************************/
 class Questset {
 	private $reponse1;
 	private $reponse2;
 	private $questions;
 
+	/*****************************************************************************
+	* Méthode __construct()                                                      *
+	*	Fonction : Constructeur, crée un objet Questset (thème) à partir de ses 	 *
+	*						 réponses   																										 *
+	*																																						 *
+	*	Paramètres :																															 *
+	*		$reponses (Array (String)) : Tableau associatif contenant les deux   		 *
+	*												 				 réponses du thème													 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*																																						 *
+	*	Exceptions :																															 *
+	*		expected_questset_array : Le paramètre n'est pas un tableau							 *
+	*****************************************************************************/
 	function __construct($reponses) {
 		if(is_array($reponses)) {
 			$this->questions = array();
@@ -35,14 +63,16 @@ class Questset {
 		}
 	}
 
-	function getQuestions() {
-		return $this->questions;
-	}
-
-	function getLength() {
-		return sizeof($this->questions);
-	}
-
+	/*****************************************************************************
+	* Méthode getArray()                                               		       *
+	*	Fonction : Renvoie un tableau associatif représentant l'objet courant  		 *
+	*																																						 *
+	*	Paramètres : Aucun																												 *
+	*																																						 *
+	*	Retour :																														 			 *
+	*		Tableau contenant les deux réponses identifiant le thème ainsi qu'un		 *
+	*			tableau de questions (voir classe Question)														 *
+	*****************************************************************************/
 	function getArray() {
 		$questions = array();
 		foreach($this->questions as $question) {

web/api/model/class.score.php

@@ -1,10 +1,36 @@
 <?php
 
+/*******************************************************************************
+* Classe Score									     																					 *
+*	Auteur : Brendan Abolivier																									 *
+* Fonction : Gérer l'affichage et l'insertion de scores 											 *
+*																																							 *
+*	Attribut :																																	 *
+*		$bdd : Connector																												   *
+*		$login : String																												 	   *
+*		$score : Int                 																							 *
+*																																							 *
+* Méthodes :																																	 *
+*		__construct()																															 *
+*		getLogin()																										             *
+*		getScore()																										             *
+*		getScores() [statique]																										 *
+*		add()	[statique]																													 *
+*******************************************************************************/
 class Score {
+  private $bdd;
   private $login;
   private $score;
-  private $bdd;
 
+  /*****************************************************************************
+	* Méthode __construct()                                                      *
+	*	Fonction : Charge un score d'après le login de son auteur            			 *
+	*																																						 *
+	*	Paramètres :																															 *
+	*		$login (String) : Login de l'auteur du score														 *
+	*																																						 *
+	*	Retour : Aucun																														 *
+	*****************************************************************************/
   function __construct($login) {
     $this->bdd = new Connector();
 
@@ -19,14 +45,49 @@ class Score {
     $this->score = $data[0]['score'];
   }
 
+
+  /*****************************************************************************
+  * Méthode getLogin()                                                         *
+  *	Fonction : Renvoie le login associé au score courant                			 *
+  *																																						 *
+  *	Paramètres : Aucun																												 *
+  *																																						 *
+  *	Retour :      																														 *
+  *   Chaîne de caractères contenant le login associé au score courant         *
+  *****************************************************************************/
   function getLogin() {
     return $this->login;
   }
 
+  /*****************************************************************************
+  * Méthode getScore()                                                         *
+  *	Fonction : Renvoie le score de l'objet courant                      			 *
+  *																																						 *
+  *	Paramètres : Aucun																												 *
+  *																																						 *
+  *	Retour :      																														 *
+  *   Entier contenant le score de l'objet courant                             *
+  *****************************************************************************/
   function getScore() {
     return $this->score;
   }
 
+  /*****************************************************************************
+  * Méthode getScores() [statique]                                             *
+  *	Fonction : Sélectionne un nombre donné dans les meilleurs ou les pires     *
+  *            scores                                                   			 *
+  *																																						 *
+  *	Paramètres :      																												 *
+  *   $nRows (Int) : Nombre de lignes à sélectionner (nombre de scores à       *
+  *                  retourner)                                                *
+  *   $direction (String) : Si vaut "desc", sélectionne par ordre décroissant  *
+  *                         (les n meilleurs scores) ; si vaut "asc",          *
+  *                         sélectionne par ordre croissant (les n pires       *
+  *                         scores)                                            *
+  *																																						 *
+  *	Retour :      																														 *
+  *   Tableau de n objets Score                                                *
+  *****************************************************************************/
   public static function getScores($nRows, $direction = "desc") {
     $bdd = new Connector();
 
@@ -44,6 +105,20 @@ class Score {
     return $scores;
   }
 
+  /*****************************************************************************
+  * Méthode add() [statique]                                                   *
+  *	Fonction : Ajoute un score dans la base de données                   			 *
+  *																																						 *
+  *	Paramètres :      																												 *
+  *   $login (String) : Login de l'auteur du score à ajouter                   *
+  *   $score (Int) : Score à ajouter                                           *
+  * 																																					 *
+  *	Retour : Aucun                                                             *
+  * 																																					 *
+  * Exceptions :                                                               *
+  *   higher_score_present : Un score supérieur existe déjà pour ce login dans *
+  *                          la base de données                                *
+  *****************************************************************************/
   public static function add($login, $score) {
     $bdd = new Connector();
 

web/css/game.css

@@ -8,14 +8,25 @@
 	100%{width: 0;background-color: #cc5757;}
 }
 
-#timer
-{
+#timer {
 	height: 20px;
 	display: block;
 	margin: auto;
+}
+
+.timer
+{
 	animation: timebar 5s linear;
 }
 
+.pause {
+	animation-play-state: paused;
+}
+
+.clearTimer {
+	animation: none;
+}
+
 #navbar li.current:last-child #score {
   display:inline;
   padding-top:17px;

web/css/game.css~

@@ -1,123 +0,0 @@
-@keyframes timebar
-{
-	0%{width: 100%;background-color: #57cc6b;}
-	30%{background-color: #57cc6b;}
-	40%{background-color: #e3a55c;}
-	60%{background-color: #e3a55c;}
-	70%{background-color: #cc5757;}
-	100%{width: 0;background-color: #cc5757;}
-}
-
-#timer
-{
-	height: 20px;
-	display: block;
-	margin: auto;
-	animation: timebar 5s infinite linear;
-}
-
-#navbar li.current:last-child #score {
-  display:inline;
-  padding-top:17px;
-  padding-left:30px;
-  padding-right:30px;
-  padding-bottom:18px;
-  background: #ffab19;
-}
-
-#game input[type="submit"]#play {
-  border:none;
-  background-color:#09b22b;
-  color:white;
-  padding:20px;
-  font-size:170%;
-  cursor:pointer;
-}
-
-#game {
-  text-align:center;
-}
-
-div#category {
-  font-size:170%;
-  font-family:'Lato';
-  font-weight:300;
-  margin-top:20px;
-}
-
-p#question {
-  font-size:120%;
-}
-
-ul#answers {
-  padding-left:0px;
-}
-
-ul#answers li {
-  display:inline-block;
-  background: #b087ff;
-  width:16%;
-  padding:20px;
-  padding-top:38px;
-  height:42px;
-  font-size:110%;
-  color:white;
-  font-weight:bold;
-  margin-right:20px;
-  line-height: 20px;
-  vertical-align: middle;
-  cursor: pointer;
-}
-
-ul#answers li.good-answer {
-  background: #57cc6b;
-}
-
-ul#answers li.wrong-answer {
-  background: #cc5757;
-}
-
-h2#score {
-  margin-top: 100px;
-  font-size:220%;
-  margin-bottom:10px;
-}
-
-p#registerScore, p#conDenied {
-  width: 40%;
-  margin: auto;
-}
-
-p.success {
-  padding-top: 30px;
-  background:#57cc6b;
-  padding-bottom: 30px;
-}
-
-p.error {
-  padding-top: 30px;
-  background:#cc5757;
-  padding-bottom: 30px;
-  color:white;
-}
-
-p#conDenied {
-  margin-top:70px;
-}
-
-@media all and (max-width: 799px) {
-  ul#answers li {
-    display:block;
-    margin:auto;
-    margin-bottom:10px;
-    width:80%;
-    padding-top:15px;
-    height: 20px;
-  }
-}
-
-@media all and (min-width: 800px) {
-  ul#answers li:last-child {
-    margin-right:0px;
-  }
-}

web/js/game.js

@@ -78,7 +78,7 @@ function loadCat(id) {
   if(id === 0) category = json.cat1;
   if(id === 1) category = json.cat2;
   console.log(category);
-  $("#game").html("<div id=\"timer\" style=\"width:100%;height:20px;background:green\"></div>");
+  $("#game").html("<div id=\"timer\"></div>");
   $("#game").append("<div id=\"category\">Catégorie : "+category.nom_cat+"</div>");
   $("#game").append("<div id=\"theme\"></div>");
   $(".current").html("<div id=\"score\">Score : "+score+" miam</div>");
@@ -173,15 +173,18 @@ function nextQuestion() {
 }
 
 function startTimer() {
-  $("#timer").css("width", "100%");
   baseWidth = $("#timer").width();
-  $("#timer").animate({'width' : '0%'}, timing*1000);
+  $("#timer").removeClass();
+  var elm = document.getElementById("timer"),
+      newone = elm.cloneNode(true);
+  elm.parentNode.replaceChild(newone, elm);
+  $("#timer").addClass("timer");
   timer = window.setTimeout(checkAnswer, timing*1000);
 }
 
 function stopTimer() {
   window.clearTimeout(timer);
-  $("#timer").stop();
+  $("#timer").addClass("pause");
   secRestantes = Math.round($("#timer").width()/baseWidth*timing);
 }
 

web/js/multi.js

@@ -211,15 +211,18 @@ function play(questions) {
 }
 
 function startTimer() {
-  $("#timer").css("width", "100%");
   baseWidth = $("#timer").width();
-  $("#timer").animate({'width' : '0%'}, timing*1000);
+  $("#timer").removeClass();
+  var elm = document.getElementById("timer"),
+      newone = elm.cloneNode(true);
+  elm.parentNode.replaceChild(newone, elm);
+  $("#timer").addClass("timer");
   timer = window.setTimeout(checkAnswer, timing*1000);
 }
 
 function stopTimer() {
   window.clearTimeout(timer);
-  $("#timer").stop();
+  $("#timer").addClass("pause");
   secRestantes = Math.round($("#timer").width()/baseWidth*timing);
 }