chamilo / chamilo-lms

main/exercice/export/aiken/aiken_classes.php

Doc Comments +4 added lines

@@ -10,6 +10,10 @@
 if ( count( get_included_files() ) == 1 ) die( '---' );
 
 if (!function_exists('mime_content_type')) {
+
+	/**
+	 * @param string $filename
+	 */
 	function mime_content_type($filename) {
 		return DocumentManager::file_get_mime_type((string)$filename);
 	}

main/exercice/export/aiken/aiken_import.inc.php

Doc Comments +6 added lines, -1 removed lines

@@ -55,6 +55,8 @@ 
  * Gets the uploaded file (from $_FILES) and unzip it to the given directory
  * @param string The directory where to do the work
  * @param string The path of the temporary directory where the exercise was uploaded and unzipped
+ * @param string $baseWorkDir
+ * @param string $uploadPath
  * @return bool True on success, false on failure
  */
 function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath) {
@@ -229,7 +231,10 @@ 
  * @param string Path to the directory with the file to be parsed (without final /)
  * @param string Name of the last directory part for the file (without /)
  * @param string Name of the file to be parsed (including extension)
- * @return mixed True on success, error message on error
+ * @param string $exercisePath
+ * @param string $file
+ * @param string $questionFile
+ * @return string|boolean True on success, error message on error
  * @assert ('','','') === false
  */
 function aiken_parse_file(&$exercise_info, $exercisePath, $file, $questionFile) {

main/exercice/export/exercise_import.inc.php

Doc Comments +5 added lines, -3 removed lines

@@ -30,6 +30,8 @@ 
  * Unzip the exercise in the temp folder
  * @param string The path of the temporary directory where the exercise was uploaded and unzipped
  * @param string
+ * @param string $baseWorkDir
+ * @param string $uploadPath
  * @return bool
  */
 function get_and_unzip_uploaded_exercise($baseWorkDir, $uploadPath)
@@ -217,9 +219,9 @@ 
 
 /**
  * Parses a given XML file and fills global arrays with the elements
- * @param $exercisePath
- * @param $file
- * @param $questionFile
+ * @param string $exercisePath
+ * @param string $file
+ * @param string $questionFile
  * @return bool
  */
 function parse_file($exercisePath, $file, $questionFile)

main/exercice/export/qti2/qti2_export.php

Doc Comments +9 added lines, -6 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Constructor.
      *
-     * @param $question Ims2Question object we want to export.
+     * @param Ims2Question $question Ims2Question object we want to export.
      */
      function ImsAssessmentItem($question)
      {
@@ -101,7 +101,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       */
      function export($standalone = false)
      {
@@ -154,7 +154,7 @@ 
 
     /**
      * Constructor.
-     * @param $exe The Exercise instance to export
+     * @param Exercise $exe The Exercise instance to export
      * @author Amand Tihon <amand@alrj.org>
      */
     function ImsSection($exe)
@@ -239,7 +239,7 @@ 
      * Export the exercise in IMS/QTI.
      *
      * @param bool $standalone Wether it should include XML tag and DTD line.
-     * @return a string containing the XML flow
+     * @return string string containing the XML flow
      * @author Amand Tihon <amand@alrj.org>
      */
     function export($standalone)
@@ -383,7 +383,7 @@ 
       * This is a default behaviour, some classes may want to override this.
       *
       * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-      * @return A string, the XML flow for an Item.
+      * @return string string, the XML flow for an Item.
       * @author Amand Tihon <amand@alrj.org>
       */
      function export($standalone = False)
@@ -417,7 +417,7 @@ 
  *
  * @param int $exerciseId The exercise to export
  * @param boolean $standalone Wether it should include XML tag and DTD line.
- * @return The XML as a string, or an empty string if there's no exercise with given ID.
+ * @return string XML as a string, or an empty string if there's no exercise with given ID.
  */
 function export_exercise_to_qti($exerciseId, $standalone = true)
 {
@@ -474,6 +474,9 @@ 
     return htmlspecialchars($text);
 }
 
+/**
+ * @param string $text
+ */
 function cleanAttribute($text)
 {
     return $text;

main/exercice/export/scorm/scorm_classes.php

Doc Comments +5 added lines, -4 removed lines

@@ -27,6 +27,7 @@ 
      * @param int  The JavaScript ID for this question.
      * Due to the nature of interactions, we must have a natural sequence for
      * questions in the generated JavaScript.
+     * @param integer $js_id
      */
     public static function export_question($questionId, $standalone = true, $js_id)
     {
@@ -687,7 +688,7 @@ 
     /**
      * Constructor.
      *
-     * @param $question The Question object we want to export.
+     * @param ScormQuestion $question The Question object we want to export.
      */
     public function ScormAssessmentItem($question, $standalone = false)
     {
@@ -915,7 +916,7 @@ 
      *
      * @param int $exerciseId The exercise to exporte
      * @param boolean $standalone Wether it should include XML tag and DTD line.
-     * @return The XML as a string, or an empty string if there's no exercise with given ID.
+     * @return string XML as a string, or an empty string if there's no exercise with given ID.
      */
     public static function export_exercise_to_scorm($exerciseId, $standalone=true) {
         $exercise = new Exercise();
@@ -930,7 +931,7 @@ 
 
     /**
      * Constructor.
-     * @param $exe The Exercise instance to export
+     * @param Exercise $exe The Exercise instance to export
      * @author Amand Tihon <amand@alrj.org>
      */
     function ScormSection($exe) {
@@ -1091,7 +1092,7 @@ 
      * This is a default behaviour, some classes may want to override this.
      *
      * @param $standalone: Boolean stating if it should be exported as a stand-alone question
-     * @return A string, the XML flow for an Item.
+     * @return string string, the XML flow for an Item.
      */
     function export()
     {

main/exercice/fill_blanks.class.php

Doc Comments +15 added lines, -14 removed lines

@@ -415,7 +415,7 @@ 
      * @param null $feedback_type
      * @param null $counter
      * @param null $score
-     * @return null|string
+     * @return string
      */
     public function return_header($feedback_type = null, $counter = null, $score = null)
     {
@@ -429,15 +429,16 @@ 
     }
 
     /**
-     * @param $separatorStartRegexp
-     * @param $separatorEndRegexp
-     * @param $correctItemRegexp
-     * @param $questionId
+     * @param string $separatorStartRegexp
+     * @param string $separatorEndRegexp
+     * @param string $correctItemRegexp
+     * @param integer $questionId
      * @param $correctItem
      * @param $attributes
-     * @param $answer
+     * @param string $answer
      * @param $listAnswersInfo
-     * @param $displayForStudent
+     * @param boolean $displayForStudent
+     * @param integer $inBlankNumber
      * @return string
      */
     public static function getFillTheBlankHtml(
@@ -736,11 +737,11 @@ 
     *  0  : student answer is correct
     * >0  : for fill the blank question with choice menu, is the index of the student answer (right answer indice is 0)
     *
-    * @param $testId
-    * @param $questionId
+    * @param integer $testId
+    * @param integer $questionId
     * @param $studentsIdList
-    * @param $startDate
-    * @param $endDate
+    * @param string $startDate
+    * @param string $endDate
     * @param bool $useLastAnswerredAttempt
     * @return array
     * (
@@ -917,7 +918,7 @@ 
      * return $text protected for use in regexp
      * @param string $text
      *
-     * @return mixed
+     * @return string
      */
     public static function getRegexpProtected($text)
     {
@@ -975,7 +976,7 @@ 
      * return the start separator for answer
      * @param string $number
      *
-     * @return mixed
+     * @return string
      */
     public static function getStartSeparator($number)
     {
@@ -988,7 +989,7 @@ 
      * return the end separator for answer
      * @param string $number
      *
-     * @return mixed
+     * @return string
      */
     public static function getEndSeparator($number)
     {

main/exercice/hotpotatoes.lib.php

Doc Comments +5 added lines, -1 removed lines

@@ -94,7 +94,7 @@ 
  * Sets the comment in the database for a particular path.
  * @param    string    File path
  * @param    string    Comment to set
- * @return   string    Result of the database operation (Database::query will output some message directly on error anyway)
+ * @return   Doctrine\DBAL\Driver\Statement|null    Result of the database operation (Database::query will output some message directly on error anyway)
  */
 function SetComment($path, $comment)
 {
@@ -112,6 +112,7 @@ 
 /**
  * Reads the file contents into a string.
  * @param    string    Urlencoded path
+ * @param string $full_file_path
  * @return   string    The file contents or false on security error
  */
 function ReadFileCont($full_file_path)
@@ -257,6 +258,7 @@ 
  * Searches for a node in the given array.
  * @param    reference    Reference to the array to search
  * @param    string       Node we are looking for in the array
+ * @param string $node
  * @return   mixed        Node name or false if not found
  */
 function myarraysearch(&$array, $node)
@@ -316,6 +318,8 @@ 
  * Fills the folder name up to a certain length with "0".
  * @param    string    Original folder name
  * @param    integer   Length to reach
+ * @param integer $name
+ * @param integer $nsize
  * @return   string    Modified folder name
  */
 function FillFolderName($name, $nsize)

main/exercice/hotpotatoes_exercise_result.class.php

Doc Comments +1 added lines

@@ -18,6 +18,7 @@
 	 * Gets the results of all students (or just one student if access is limited)
 	 * @param	string		The document path (for HotPotatoes retrieval)
 	 * @param	integer		User ID. Optional. If no user ID is provided, we take all the results. Defauts to null
+	 * @param string $document_path
 	 */
 	public function getExercisesReporting($document_path, $hotpotato_name)
     {

main/exercice/hotspot.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -52,7 +52,7 @@
 	/**
 	 * @param FormValidator $form
 	 * @param null $objExercise
-	 * @return bool
+	 * @return null|false
 	 */
 	public function processCreation($form, $objExercise = null)
 	{