chamilo / chamilo-lms

src/Chamilo/UserBundle/Entity/User.php

Doc Comments +6 added lines, -6 removed lines

@@ -643,7 +643,7 @@ 
     }
 
     /**
-     * @param $portal
+     * @param AccessUrlRelUser $portal
      */
     public function setPortal($portal)
     {
@@ -1003,7 +1003,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1311,7 +1311,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -2088,7 +2088,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     public function getPlainPassword()
     {
@@ -2100,7 +2100,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {
@@ -2425,7 +2425,7 @@ 
     /**
      * Check if the user has the skill
      * @param Skill $skill The skill
-     * @return boolean
+     * @return boolean|null
      */
     public function hasSkill(Skill $skill)
     {

main/inc/lib/online.inc.php

Doc Comments +9 added lines, -2 removed lines

@@ -209,11 +209,11 @@ 
 /**
  * Gives a list of people online now (and in the last $valid minutes)
  *
- * @param $from
+ * @param integer $from
  * @param $number_of_items
  * @param null $column
  * @param null $direction
- * @param null $time_limit
+ * @param integer $time_limit
  * @param bool $friends
  * @return  array|bool For each line, a list of user IDs and login dates, or FALSE on error or empty results
  */
@@ -320,6 +320,9 @@ 
     }
 }
 
+/**
+ * @param string $time_limit
+ */
 function who_is_online_count($time_limit = null, $friends = false)
 {
     if (empty($time_limit)) {
@@ -436,6 +439,10 @@ 
 	}
 }
 
+/**
+ * @param integer $uid
+ * @param string|null $time_limit
+ */
 function who_is_online_in_this_course_count($uid, $time_limit, $coursecode=null)
 {
 	if (empty($coursecode)) {

main/gradebook/lib/user_data_generator.class.php

Doc Comments +4 added lines, -4 removed lines

@@ -285,7 +285,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 +306,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 +323,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 +339,7 @@ 
 
     /**
      * @param $coursecode
-     * @return mixed
+     * @return string
      */
     private function get_course_name_from_code_cached($coursecode)
     {

main/inc/lib/course.lib.php

Doc Comments +8 added lines, -5 removed lines

@@ -813,7 +813,7 @@ 
      * @param  string $courseCode the course code
      * @param  int $visible (optional) The course visibility in the catalogue to the user (1=visible, 0=invisible)
      *
-     * @return boolean true if added succesfully, false otherwise.
+     * @return boolean|string true if added succesfully, false otherwise.
      */
     public static function addUserVisibilityToCourseInCatalogue($userId, $courseCode, $visible = 1)
     {
@@ -1784,6 +1784,7 @@ 
      * @param   string  Course code
      * @param   int     Session ID
      * @param   bool $addGeneralCoach
+     * @param integer $session_id
      * @return  array   List of users
      */
     public static function get_coach_list_from_course_code($course_code, $session_id, $addGeneralCoach = true)
@@ -2418,7 +2419,7 @@ 
 
     /**
      * Creates a file called mysql_dump.sql in the course folder
-     * @param $course_code The code of the course
+     * @param string $course_code The code of the course
      * @todo Implementation for single database
      */
     public static function create_database_dump($course_code)
@@ -3212,6 +3213,7 @@ 
      * @param int $limit
      * @param string $column
      * @param string $direction
+     * @param integer $status
      * @return array    courses
      */
     public static function get_courses_followed_by_drh(
@@ -3806,6 +3808,7 @@ 
      *  class userportal-course-item.
      * @param int      User category id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_category_id
      * @return string
      */
     public static function returnCoursesWithoutCategories($user_category_id, $load_dirs = false)
@@ -4992,7 +4995,7 @@ 
     /**
      * Returns the SQL conditions to filter course only visible by the user in the catalogue
      *
-     * @param $courseTableAlias Alias of the course table
+     * @param string $courseTableAlias Alias of the course table
      * @return string SQL conditions
      */
     public static function getCourseVisibilitySQLCondition($courseTableAlias) {
@@ -6087,11 +6090,11 @@ 
 
     /**
      * @param int $user_id
-     * @param $filter
+     * @param string $filter
      * @param bool $load_dirs
      * @param int $getCount
      * @param int $start
-     * @param null $maxPerPage
+     * @param integer $maxPerPage
      * @return null|string
      */
     public static function displayCourses($user_id, $filter, $load_dirs, $getCount, $start = null, $maxPerPage = null)

src/Chamilo/SettingsBundle/Manager/SettingsManager.php

Doc Comments +8 added lines, -5 removed lines

@@ -125,7 +125,7 @@ 
 
     /**
      * Get variables and categories as in 1.11.x
-     * @return array
+     * @return string
      */
     public function getVariablesAndCategories()
     {
@@ -428,7 +428,7 @@ 
     /**
      * Rename old variable with variable used in Chamilo 2.0
      * @param string $variable
-     * @return mixed
+     * @return string
      */
     public function renameVariable($variable)
     {
@@ -464,7 +464,7 @@ 
      * Replace old Chamilo 1.x category with 2.0 version
      * @param string $variable
      * @param string $defaultCategory
-     * @return mixed
+     * @return string
      */
     public function fixCategory($variable, $defaultCategory)
     {
@@ -558,8 +558,8 @@ 
     }
 
     /**
-     * @param $name
-     * @return mixed
+     * @param string $name
+     * @return string
      * @throws \InvalidArgumentException
      */
     public function getSetting($name)
@@ -843,6 +843,9 @@ 
         return $parameters;
     }
 
+    /**
+     * @param string $namespace
+     */
     public function getParametersFromKeyword($namespace, $keyword = '')
     {
         $criteria = array('category' => $namespace);

main/inc/lib/usermanager.lib.php

Doc Comments +25 added lines, -18 removed lines

@@ -132,9 +132,9 @@ 
     /**
      * Validates the password
      *
-     * @param $encoded
-     * @param $raw
-     * @param $salt
+     * @param string $encoded
+     * @param string $raw
+     * @param string $salt
      * @return bool
      */
     public static function isPasswordValid($encoded, $raw, $salt)
@@ -149,7 +149,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -1096,6 +1096,7 @@ 
     /**
      * Disables a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1112,6 +1113,7 @@ 
     /**
      * Enable a user
      * @param int User id
+     * @param integer $user_id
      * @return bool
      * @uses UserManager::change_active_state() to actually disable the user
      * @assert (0) === false
@@ -1278,6 +1280,7 @@ 
      * Checks whether the user id exists in the database
      *
      * @param int User id
+     * @param integer $userId
      * @return bool True if user id was found, false otherwise
      */
     public static function is_user_id_valid($userId)
@@ -1419,7 +1422,7 @@ 
     /**
      * Get a list of users of which the given conditions match with a LIKE '%cond%'
      * @param array $conditions a list of condition (exemple : status=>STUDENT)
-     * @param array $order_by a list of fields on which sort
+     * @param string[] $order_by a list of fields on which sort
      * @return array An array with all users of the platform.
      * @todo optional course code parameter, optional sorting parameters...
      * @todo security filter order_by
@@ -1490,7 +1493,7 @@ 
      * @param   array $userInfo user information to avoid query the DB
      * returns the /main/img/unknown.jpg image set it at true
      *
-     * @return    array     Array of 2 elements: 'dir' and 'file' which contain
+     * @return    integer     Array of 2 elements: 'dir' and 'file' which contain
      * the dir and file as the name implies if image does not exist it will
      * return the unknow image if anonymous parameter is true if not it returns an empty array
      */
@@ -1982,7 +1985,7 @@ 
     /**
      * Returns an array with the user's productions.
      *
-     * @param    $user_id    User id
+     * @param    integer $user_id    User id
      * @return   array  An array containing the user's productions
      */
     public static function get_user_productions($user_id)
@@ -2137,7 +2140,7 @@ 
 
     /**
      * Build a list of extra file already uploaded in $user_folder/{$extra_field}/
-     * @param $user_id
+     * @param integer $user_id
      * @param $extra_field
      * @param bool $force
      * @param bool $showDelete
@@ -2242,7 +2245,7 @@ 
      * @param    int       $fieldType  Field's type
      * @param    string    $displayText Field's language var name
      * @param    string    $default Field's default value
-     * @return int
+     * @return boolean
      */
     public static function create_extra_field($variable, $fieldType, $displayText, $default)
     {
@@ -2276,6 +2279,7 @@ 
      * @param    boolean    Whether to prefix the fields indexes with "extra_" (might be used by formvalidator)
      * @param    boolean    Whether to return invisible fields as well
      * @param    boolean    Whether to split multiple-selection fields or not
+     * @param boolean $field_filter
      * @return    array    Array of fields => value for the given user
      */
     public static function get_extra_user_data(
@@ -2550,6 +2554,7 @@ 
     /**
      * Get extra user data by field variable
      * @param string    field variable
+     * @param string $field_variable
      * @return array    data
      */
     public static function get_extra_user_data_by_field_variable($field_variable)
@@ -3119,7 +3124,7 @@ 
      * @param    string  $user_id   User ID
      * @param   string  $course course directory
      * @param   string  $resourcetype resourcetype: images, all
-     * @return    int        User ID (or false if not found)
+     * @return    string        User ID (or false if not found)
      */
     public static function get_user_upload_files_by_course($user_id, $course, $resourcetype = 'all')
     {
@@ -3203,7 +3208,7 @@ 
     /**
      * Adds a new API key to the users' account
      * @param   int     Optional user ID (defaults to the results of api_get_user_id())
-     * @return  boolean True on success, false on failure
+     * @return  false|string True on success, false on failure
      */
     public static function add_api_key($user_id = null, $api_service = 'dokeos')
     {
@@ -3258,6 +3263,7 @@ 
      * Regenerate an API key from the user's account
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string  API key's internal ID
+     * @param string $api_service
      * @return  int        num
      */
     public static function update_api_key($user_id, $api_service)
@@ -3287,6 +3293,7 @@ 
     /**
      * @param   int     user ID (defaults to the results of api_get_user_id())
      * @param   string    API key's internal ID
+     * @param string $api_service
      * @return  int    row ID, or return false if not found
      */
     public static function get_api_key_id($user_id, $api_service)
@@ -3502,7 +3509,7 @@ 
      * @param int $field_id
      * @param bool $show_links show links or not
      *
-     * @return array
+     * @return string
      */
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
     {
@@ -3599,7 +3606,7 @@ 
      * @param mixed $tag
      * @param int $user_id
      * @param int $field_id field id of the tag
-     * @return bool
+     * @return boolean|null
      */
     public static function add_tag($tag, $user_id, $field_id)
     {
@@ -5045,7 +5052,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_user_field_types()
     {
@@ -5337,7 +5344,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5389,7 +5396,7 @@ 
      * Get either a Gravatar URL or complete image tag for a specified email address.
      *
      * @param string $email The email address
-     * @param string $s Size in pixels, defaults to 80px [ 1 - 2048 ]
+     * @param integer $s Size in pixels, defaults to 80px [ 1 - 2048 ]
      * @param string $d Default imageset to use [ 404 | mm | identicon | monsterid | wavatar ]
      * @param string $r Maximum rating (inclusive) [ g | pg | r | x ]
      * @param boole $img True to return a complete IMG tag False for just the URL
@@ -5755,9 +5762,9 @@ 
      * @param bool $get_count
      * @param bool $reverse_order
      * @param int $start
-     * @param null $maxPerPage
+     * @param integer $maxPerPage
      * @param null $categoryFilter
-     * @return array
+     * @return integer
      */
     public static function getCategories(
         $user_id,

main/inc/lib/api.lib.php

Doc Comments +7 added lines, -2 removed lines

@@ -1222,6 +1222,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)
@@ -2976,7 +2977,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)
 {
@@ -5153,6 +5154,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)
@@ -6201,6 +6203,7 @@ 
 
 /**
  * Returns the <script> HTML tag
+ * @param string $file
  * @return string
  */
 function api_get_css_asset($file, $media = 'screen')
@@ -6507,7 +6510,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(
@@ -6548,6 +6551,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) {
@@ -6968,6 +6972,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/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -75,7 +75,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      * @param bool $showQuery
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params, $showQuery = false)
@@ -531,7 +531,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -624,7 +624,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false
@@ -686,7 +686,7 @@ 
      * @param string $field_value Data we are looking for in the given field
      * @param bool $transform Whether to transform the result to a human readable strings
      * @param bool $last Whether to return the last element or simply the first one we get
-     * @return mixed Give the ID if found, or false on failure or not found
+     * @return string|null Give the ID if found, or false on failure or not found
      * @assert (-1,-1) === false
      */
     public function get_item_id_from_field_variable_and_field_value(