chamilo / chamilo-lms

main/gradebook/lib/user_data_generator.class.php

Doc Comments +5 added lines, -4 removed lines

@@ -72,6 +72,7 @@ 
 
     /**
      * Get actual array data
+     * @param integer $count
      * @return array 2-dimensional array - each array contains the elements:
      * 0: eval/link object
      * 1: item name
@@ -285,7 +286,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_average_column($item, $ignore_score_color)
@@ -306,7 +307,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_result_column($item, $ignore_score_color)
@@ -323,7 +324,7 @@ 
 
     /**
      * @param $item
-     * @param $ignore_score_color
+     * @param boolean $ignore_score_color
      * @return string
      */
     private function build_mask_column($item, $ignore_score_color)
@@ -339,7 +340,7 @@ 
 
     /**
      * @param $coursecode
-     * @return mixed
+     * @return string
      */
     private function get_course_name_from_code_cached($coursecode)
     {

main/inc/lib/webservices/WebService.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,8 +20,8 @@
 
     /**
      * Class constructor
-     * @param $username
-     * @param $apiKey
+     * @param string $username
+     * @param string $apiKey
      */
     protected function __construct($username, $apiKey)
     {

main/inc/lib/api.lib.php

Doc Comments +6 added lines, -2 removed lines

@@ -1240,6 +1240,7 @@ 
  * Gets the list of courses a specific user is subscribed to
  * @param int       User ID
  * @param boolean   $fetch_session Whether to get session courses or not - NOT YET IMPLEMENTED
+ * @param integer $userid
  * @return array    Array of courses in the form [0]=>('code'=>xxx,'db'=>xxx,'dir'=>xxx,'status'=>d)
  */
 function api_get_user_courses($userid, $fetch_session = true)
@@ -2955,7 +2956,7 @@ 
 * on the session visibility
 * @param bool $tutor  Whether to check if the user has the tutor role
 * @param bool  $coach Whether to check if the user has the coach role
-* @return boolean true: the user has the rights to edit, false: he does not
+* @return boolean|null true: the user has the rights to edit, false: he does not
 */
 function api_is_allowed_to_session_edit($tutor = false, $coach = false)
 {
@@ -5188,6 +5189,7 @@ 
  * @param string    Whether we want a simple list (display a category) or
  * a grouped list (group by variable as in settings.php default). Values: 'list' or 'group'
  * @param int       Access URL's ID. Optional. Uses 1 by default, which is the unique URL
+ * @param string $cat
  * @return array    Array of database results for the current settings of the current access URL
  */
 function & api_get_settings($cat = null, $ordering = 'list', $access_url = 1, $url_changeable = 0)
@@ -6614,7 +6616,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6655,6 +6657,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
+ * @param integer $user_id
  * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
@@ -7099,6 +7102,7 @@ 
 /**
  * Gets memory limit in bytes
  * @param string The memory size (128M, 1G, 1000K, etc)
+ * @param string $mem
  * @return int
  * @assert (null) === false
  * @assert ('1t')  === 1099511627776

main/work/work.lib.php

Doc Comments +14 added lines, -12 removed lines

@@ -695,7 +695,7 @@ 
  * @author Bert Vanderkimpen
  * @author Yannick Warnier <ywarnier@beeznest.org> Adaptation for work tool
  * @param   string $base_work_dir Base work dir (.../work)
- * @param   string $desiredDirName complete path of the desired name
+ * @param   string $desired_dir_name complete path of the desired name
  *
  * @return  string actual directory name if it succeeds, boolean false otherwise
  */
@@ -717,7 +717,7 @@ 
 /**
  * Delete a work-tool directory
  * @param   int  $id work directory id to delete
- * @return  integer -1 on error
+ * @return  boolean|null -1 on error
  */
 function deleteDirWork($id)
 {
@@ -860,7 +860,7 @@ 
  * Update the url of a dir in the student_publication table
  * @param  array $work_data work original data
  * @param  string $newPath Example: "folder1"
- * @return bool
+ * @return boolean|null
  */
 function updateDirName($work_data, $newPath)
 {
@@ -921,6 +921,7 @@ 
 /**
  * Transform an all directory structure (only directories) in an array
  * @param   string path of the directory
+ * @param string $directory
  * @return  array the directory structure into an array
  * @author  Julio Montoya Dokeos
  * @version April 2008
@@ -990,7 +991,7 @@ 
  * @param   string the path of the directory
  * @param   boolean true if we want the total quantity of files
  * include in others child directories, false only  files in the directory
- * @return  array the first element is an integer with the number of files
+ * @return  integer[] the first element is an integer with the number of files
  * in the folder, the second element is the number of directories
  * @author  Julio Montoya
  * @version April 2008
@@ -2723,7 +2724,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2997,6 +2998,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3668,7 +3670,7 @@ 
  * @param array $formValues
  * @param int $user_id
  * @param array $courseInfo
- * @param int $group_id
+ * @param integer $groupId
  * @param int $session_id
  * @return bool|int
  * @note $params can have the following elements, but should at least have the 2 first ones: (
@@ -4173,7 +4175,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4546,7 +4548,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4664,7 +4666,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4710,7 +4712,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4848,7 +4850,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -4962,7 +4964,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

main/inc/lib/webservices/Rest.php

Doc Comments -1 removed lines

@@ -318,7 +318,6 @@
     }
 
     /**
-     * @param int $courseId
      * @return array
      * @throws Exception
      */

src/Chamilo/CoreBundle/Composer/ScriptHandler.php

Doc Comments +2 added lines, -2 removed lines

@@ -45,7 +45,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getFoldersToDelete()
     {
@@ -95,7 +95,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getFilesToDelete()
     {

plugin/ims_lti/ImsLtiPlugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
     /**
      * Get the class instance
      * @staticvar MsiLtiPlugin $result
-     * @return MsiLtiPlugin
+     * @return ImsLtiPlugin
      */
     public static function create()
     {

plugin/ims_lti/ImsLtiTool.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
         return $this->id;
     }
 
+    /**
+     * @return string
+     */
     public function getName()
     {
         return $this->name;

plugin/ims_lti/OAuthSimple.php

Doc Comments +3 added lines

@@ -334,6 +334,9 @@
         return preg_replace('/, $/','',$result);
     }
 
+    /**
+     * @param string $paramString
+     */
     private function _parseParameterString ($paramString)
     {
         $elements = explode('&',$paramString);