[Fusionforge-commits] r18291 - trunk/src/common/survey

Marc-Etienne VARGENAU vargenau at fusionforge.org
Wed Oct 23 17:48:09 CEST 2013


Author: vargenau
Date: 2013-10-23 17:48:09 +0200 (Wed, 23 Oct 2013)
New Revision: 18291

Modified:
   trunk/src/common/survey/SurveyQuestion.class.php
   trunk/src/common/survey/SurveyQuestionFactory.class.php
Log:
Update PHP Doc

Modified: trunk/src/common/survey/SurveyQuestion.class.php
===================================================================
--- trunk/src/common/survey/SurveyQuestion.class.php	2013-10-23 15:45:08 UTC (rev 18290)
+++ trunk/src/common/survey/SurveyQuestion.class.php	2013-10-23 15:48:09 UTC (rev 18291)
@@ -82,15 +82,15 @@
 	/**
 	 * create - use this function to create a survey question
 	 *
-	 * @param	string	The question
-	 * @param	int	The question type
+	 * @param	string	$question		The question
+	 * @param	int		$question_type	The question type
 	 *                      1: Radio Buttons 1-5
 	 *                      2: Text Area
 	 *                      3: Radio Buttons Yes/No
 	 *                      4: Comment Only
 	 *                      5: Text Field
 	 *                      6: None
-	 * @return	boolean	success.
+	 * @return	bool	success.
 	 */
 	function create($question, $question_type = 1) {
 		if (strlen($question) < 3) {
@@ -98,7 +98,7 @@
 			return false;
 		} else {
 			// Current permissions check.
-			// permission should be checked in higer level to faciliate usability
+			// permission should be checked in higher level to facilitate usability
 		}
 
 		$group_id = $this->Group->GetID();
@@ -120,8 +120,8 @@
 	/**
 	 * update - use this function to update a survey question
 	 *
-	 * @param	string	The question
-	 * @param	int	The question type
+	 * @param	string	$question		The question
+	 * @param	int		$question_type	The question type
 	 *                      1: Radio Buttons 1-5
 	 *                      2: Text Area
 	 *                      3: Radio Buttons Yes/No
@@ -178,8 +178,8 @@
 	/**
 	 * fetchData - re-fetch the data for this survey question from the database.
 	 *
-	 * @param	int	The survey question_id.
-	 * @return	boolean	success.
+	 * @param	int	$question_id	The survey question_id.
+	 * @return	bool	success.
 	 */
 	function fetchData($question_id) {
 		$group_id = $this->Group->GetID();

Modified: trunk/src/common/survey/SurveyQuestionFactory.class.php
===================================================================
--- trunk/src/common/survey/SurveyQuestionFactory.class.php	2013-10-23 15:45:08 UTC (rev 18290)
+++ trunk/src/common/survey/SurveyQuestionFactory.class.php	2013-10-23 15:48:09 UTC (rev 18291)
@@ -45,7 +45,7 @@
 	/**
 	 *  Constructor.
 	 *
-	 *	@param	object	The Group object to which this survey question is associated.
+	 *	@param	object	$Group	The Group object to which this survey question is associated.
 	 */
 	function __construct(&$Group) {
 		$this->Error();
@@ -81,7 +81,7 @@
  	 *	@return	array	The array of Survey Question objects.
 	 */
 	function &getSurveyQuestions() {
-		/* We alread have it */
+		/* We already have it */
 		if ($this->questions) {
 			return $this->questions;
 		}




More information about the Fusionforge-commits mailing list