chamilo / chamilo-lms

main/inc/lib/system/web/request.class.php

Doc Comments +4 added lines

@@ -31,6 +31,10 @@
         return $method == 'GET';
     }
 
+    /**
+     * @param string $key
+     * @param string $default
+     */
     public static function post($key, $default = null)
     {
         return isset($_POST[$key]) ? $_POST[$key] : $default;

main/inc/lib/table_sort.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 	 * @param string $direction The direction to sort (SORT_ASC (default) orSORT_DESC)
 	 * @param array $column_show The columns that we will show in the table i.e: $column_show = array('1','0','1') we will show the 1st and the 3th column.
 	 * @param array $column_order Changes how the columns will be sorted ie. $column_order = array('0','3','2','3') The column [1] will be sorted like the column [3]
-	 * @param constant $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
+	 * @param integer $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
 	 * @return array The sorted dataset
 	 * @author bart.mollet@hogent.be
 	 */

main/inc/lib/template.lib.php

Doc Comments +2 added lines

@@ -330,6 +330,7 @@ 
     /**
      * Sets the footer visibility
      * @param bool true if we show the footer
+     * @param boolean $status
      */
     public function set_footer($status)
     {
@@ -370,6 +371,7 @@ 
     /**
      * Sets the header visibility
      * @param bool true if we show the header
+     * @param boolean $status
      */
     public function set_header($status)
     {

main/inc/lib/text.lib.php

Doc Comments +10 added lines, -5 removed lines

@@ -52,6 +52,7 @@ 
  * Converts the text of a html-document to a given encoding, the meta-tag is changed accordingly.
  * @param string $string                The input full-html document.
  * @param string                        The new encoding value to be set.
+ * @param string $encoding
  */
 function api_set_encoding_html(&$string, $encoding) {
     $old_encoding = api_detect_encoding_html($string);
@@ -74,7 +75,7 @@ 
  * Returns the title of a html document.
  * @param string $string                The contents of the input document.
  * @param string $input_encoding        The encoding of the input document. If the value is not set, it is detected.
- * @param string $$output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
+ * @param string $output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
  * @return string                       The retrieved title, html-entities and extra-whitespace between the words are cleaned.
  */
 function api_get_title_html(&$string, $output_encoding = null, $input_encoding = null) {
@@ -433,7 +434,7 @@ 
  * @since wordpress  2.8.1
  * @access private
  *
- * @param string|array $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
+ * @param string[] $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
  * @param string $subject The string being searched and replaced on, otherwise known as the haystack.
  * @return string The string with the replaced svalues.
  */
@@ -628,6 +629,7 @@ 
  * @param string    The text to "cut"
  * @param int       Count of chars
  * @param bool      Whether to embed in a <span title="...">...</span>
+ * @param integer $maxchar
  * @return string
  * */
 function cut($text, $maxchar, $embed = false) {
@@ -645,7 +647,7 @@ 
  *
  * @param mixed     Number to convert
  * @param int       Decimal points 0=never, 1=if needed, 2=always
- * @return mixed    An integer or a float depends on the parameter
+ * @return string|null    An integer or a float depends on the parameter
  */
 function float_format($number, $flag = 1) {
     if (is_numeric($number)) {
@@ -689,7 +691,7 @@ 
 /**
  * Gets the week from a day
  * @param   string   Date in UTC (2010-01-01 12:12:12)
- * @return  int      Returns an integer with the week number of the year
+ * @return  string      Returns an integer with the week number of the year
  */
 function get_week_from_day($date) {
     if (!empty($date)) {
@@ -739,6 +741,9 @@ 
 	return $output.$end;
 }
 
+/**
+ * @param string $glue
+ */
 function implode_with_key($glue, $array) {
     if (!empty($array)) {
         $string = '';
@@ -817,7 +822,7 @@ 
 /**
  * @param string $string
  * @param bool $capitalizeFirstCharacter
- * @return mixed
+ * @return string
  */
 function underScoreToCamelCase($string, $capitalizeFirstCharacter = true)
 {

main/inc/lib/timeline.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
      * @todo the form should be auto generated
      * @param   string  url
      * @param   string  action add, edit
-     * @return  obj     form validator obj
+     * @return  FormValidator     form validator obj
      */
     public function return_form($url, $action)
     {

main/inc/lib/tracking.lib.php

Doc Comments +13 added lines, -7 removed lines

@@ -1287,6 +1287,8 @@ 
      * @param   string type of time filter: 'last_week' or 'custom'
      * @param   string  start date date('Y-m-d H:i:s')
      * @param   string  end date date('Y-m-d H:i:s')
+     * @param string $start_date
+     * @param string $end_date
      * @return timestamp $nb_seconds
      */
     public static function get_time_spent_on_the_platform(
@@ -1390,7 +1392,7 @@ 
      * Get first connection date for a student
      * @param    int $student_id
      *
-     * @return    string|bool Date format long without day or false if there are no connections
+     * @return    string|false Date format long without day or false if there are no connections
      */
     public static function get_first_connection_date($student_id)
     {
@@ -1420,7 +1422,7 @@ 
      * @param int $student_id
      * @param bool $warning_message Show a warning message (optional)
      * @param bool $return_timestamp True for returning results in timestamp (optional)
-     * @return string|int|bool Date format long without day, false if there are no connections or
+     * @return string Date format long without day, false if there are no connections or
      * timestamp if parameter $return_timestamp is true
      */
     public static function get_last_connection_date($student_id, $warning_message = false, $return_timestamp = false)
@@ -2667,6 +2669,9 @@ 
      * @param     array         Limit average to listed lp ids
      * @param     int            Session id (optional), if param $session_id is
      * null(default) it'll return results including sessions, 0 = session is not filtered
+     * @param integer $student_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return     int         Total time
      */
     public static function get_time_spent_in_lp($student_id, $course_code, $lp_ids = array(), $session_id = null)
@@ -2733,6 +2738,8 @@ 
      * @param     int|array    Student id(s)
      * @param     string         Course code
      * @param     int         Learning path id
+     * @param integer $student_id
+     * @param string $course_code
      * @return     int         Total time
      */
     public static function get_last_connection_time_in_lp($student_id, $course_code, $lp_id, $session_id = 0)
@@ -5400,7 +5407,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {
@@ -5439,7 +5446,6 @@ 
      * @param   int $sessionId  The session ID (session.id)
      * @param   int $courseId   The course ID (course.id)
      * @param   int $exerciseId The quiz ID (c_quiz.id)
-     * @param   int $answer     The answer status (0 = incorrect, 1 = correct, 2 = both)
      * @param   array   $options    An array of options you can pass to the query (limit, where and order)
      * @return array An array with the data of exercise(s) progress
      */
@@ -6876,7 +6882,7 @@ 
      * @param int $user_id
      * @param int $course_id
      * @param int $session_id
-     * @return array
+     * @return string[]
      */
     public function display_login_tracking_info($view, $user_id, $course_id, $session_id = 0)
     {
@@ -6922,9 +6928,9 @@ 
     /**
      * Displays the exercise results for a specific user in a specific course.
      * @param   string $view
-     * @param   int $user_id    User ID
+     * @param   int $userId    User ID
      * @param   string  $courseCode Course code
-     * @return array
+     * @return string[]
      * @todo remove globals
      */
     public function display_exercise_tracking_info($view, $userId, $courseCode)

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -14 removed lines

@@ -18,7 +18,7 @@ 
     * @param	string	$url The URL of the site
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return boolean if success
+    * @return Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function add($url, $description, $active)
     {
@@ -43,7 +43,7 @@ 
     * @param	string 	$url
     * @param	string  $description The description of the site
     * @param	int		$active is active or not
-    * @return 	boolean if success
+    * @return 	Doctrine\DBAL\Driver\Statement|null if success
     */
     public static function update($url_id, $url, $description, $active)
     {
@@ -67,7 +67,7 @@ 
     * @author Julio Montoya
     * @param int $id url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete($id)
     {
@@ -366,7 +366,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_user_exist($user_id, $url_id)
     {
@@ -384,7 +384,7 @@ 
     * @author Julio Montoya
     * @param int $courseId
     * @param int $urlId
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_course_exist($courseId, $urlId)
     {
@@ -405,7 +405,7 @@ 
      * @author Julio Montoya
      * @param int $userGroupId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
     {
@@ -424,7 +424,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_session_exist($session_id, $url_id)
     {
@@ -545,6 +545,8 @@ 
      * @author Julio Montoya
      * @param  array of course ids
      * @param  array of url_ids
+     * @param integer[] $courseCategoryList
+     * @param integer[] $urlList
      * @return array
      **/
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -575,7 +577,7 @@ 
      * @author Julio Montoya
      * @param int $categoryCourseId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
     {
@@ -592,7 +594,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -692,7 +694,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -763,7 +765,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -781,7 +783,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -800,7 +802,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -819,7 +821,7 @@ 
     * @param  char  course code
     * @param  int url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {

main/inc/lib/usergroup.lib.php

Doc Comments +12 added lines, -6 removed lines

@@ -1013,7 +1013,7 @@ 
      * @param int    $groupId
      * @param string $picture
      *
-     * @return bool|string
+     * @return false|string
      */
     public function manageFileUpload($groupId, $picture)
     {
@@ -1155,7 +1155,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getGroupType()
     {
@@ -1359,6 +1359,8 @@ 
      * @param string height
      * @param string picture size it can be small_,  medium_  or  big_
      * @param string style css
+     * @param integer $height
+     * @param integer $size_picture
      * @return array with the file and the style of an image i.e $array['file'] $array['style']
      */
     public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM , $style = '')
@@ -1420,7 +1422,7 @@ 
      * @param	string	Type of path to return (can be 'none', 'system', 'rel', 'web')
      * @param	bool	Whether we want to have the directory name returned 'as if' there was a file or not (in the case we want to know which directory to create - otherwise no file means no split subdir)
      * @param	bool	If we want that the function returns the /main/img/unknown.jpg image set it at true
-     * @return	array 	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 er's
+     * @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 er's
      */
     public function get_group_picture_path_by_id($id, $type = 'none', $preview = false, $anonymous = false)
     {
@@ -1470,7 +1472,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAllowedPictureExtensions()
     {
@@ -1660,7 +1662,7 @@ 
      * @author Julio Montoya
      * @param  int  $user_id
      * @param  int $group_id
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public function delete_user_rel_group($user_id, $group_id)
     {
@@ -1872,6 +1874,8 @@ 
      * @param int from value
      * @param int limit
      * @param array image configuration, i.e array('height'=>'20px', 'size'=> '20px')
+     * @param integer $from
+     * @param integer $limit
      * @return array list of users in a group
      */
     public function get_users_by_group(
@@ -1970,6 +1974,8 @@ 
      * Shows the left column of the group page
      * @param int group id
      * @param int user id
+     * @param integer $group_id
+     * @param integer $user_id
      *
      */
     public function show_group_column_information($group_id, $user_id, $show = '')
@@ -2323,7 +2329,7 @@ 
      * @param int $group_id
      * @param int $parent_group_id if 0, we delete the parent_group association
      * @param int $relation_type
-     * @return resource
+     * @return Doctrine\DBAL\Driver\Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {

main/inc/lib/usermanager.lib.php

Doc Comments +31 added lines, -15 removed lines

@@ -86,7 +86,7 @@ 
     }
 
     /**
-     * @return bool|mixed
+     * @return string
      */
     public static function getPasswordEncryption()
     {
@@ -161,7 +161,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -965,6 +965,7 @@ 
      * Disables or enables a user
      * @param int user_id
      * @param int Enable or disable
+     * @param integer $active
      * @return void
      * @assert (-1,0) === false
      * @assert (1,1) === true
@@ -995,6 +996,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
@@ -1011,6 +1013,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
@@ -1175,6 +1178,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)
@@ -1357,7 +1361,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
      */
@@ -1729,7 +1733,7 @@ 
      * @param    int $user_id    User id
      * @param    $force    Optional parameter to force building after a removal request
      *
-     * @return    A string containing the XHTML code to dipslay the production list, or FALSE
+     * @return    boolean|string string containing the XHTML code to dipslay the production list, or FALSE
      */
     public static function build_production_list($user_id, $force = false, $showdelete = false)
     {
@@ -1765,7 +1769,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)
@@ -1920,7 +1924,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
@@ -2023,7 +2027,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)
     {
@@ -2056,6 +2060,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(
@@ -2242,7 +2247,6 @@ 
     /**
      * Get all the extra field information of a certain field (also the options)
      *
-     * @param int $field_name the name of the field we want to know everything of
      * @return array $return containing all th information about the extra profile field
      * @author Julio Montoya
      * @deprecated
@@ -2285,6 +2289,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)
@@ -2829,7 +2834,7 @@ 
      * @param    string    User ID
      * @param   string  course directory
      * @param   string  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')
     {
@@ -2909,7 +2914,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')
     {
@@ -2964,6 +2969,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)
@@ -2993,6 +2999,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)
@@ -3204,7 +3211,8 @@ 
      * @param int user_id
      * @param int field_id
      * @param bool show links or not
-     * @return array
+     * @param integer $user_id
+     * @return string
      */
     public static function get_user_tags_to_string($user_id, $field_id, $show_links = true)
     {
@@ -3249,6 +3257,8 @@ 
      * Get the tag id
      * @param int tag
      * @param int field_id
+     * @param string $tag
+     * @param integer $field_id
      * @return int returns 0 if fails otherwise the tag id
      */
     public static function get_tag_id($tag, $field_id)
@@ -3295,7 +3305,7 @@ 
      * @param mixed tag
      * @param int The user id
      * @param int field id of the tag
-     * @return bool
+     * @return boolean|null
      */
     public static function add_tag($tag, $user_id, $field_id)
     {
@@ -4101,7 +4111,7 @@ 
      * Add subscribed users to a user by relation type
      * @param int $userId The user id
      * @param array $subscribedUsersId The id of suscribed users
-     * @param action $relationType The relation type
+     * @param integer $relationType The relation type
      */
     public static function subscribeUsersToUser($userId, $subscribedUsersId, $relationType)
     {
@@ -4158,6 +4168,8 @@ 
      * This function check if an user is followed by human resources manager
      * @param     int     User id
      * @param    int        Human resources manager
+     * @param integer $user_id
+     * @param integer $hr_dept_id
      * @return    bool
      */
     public static function is_user_followed_by_drh($user_id, $hr_dept_id)
@@ -4230,6 +4242,8 @@ 
      * Determines if a user is a gradebook certified
      * @param int The category id of gradebook
      * @param int The user id
+     * @param integer $cat_id
+     * @param integer $user_id
      * @return boolean
      */
     public static function is_user_certified($cat_id, $user_id)
@@ -4252,6 +4266,8 @@ 
      * Gets the info about a gradebook certificate for a user by course
      * @param string The course code
      * @param int The user id
+     * @param integer $course_code
+     * @param integer $user_id
      * @return array  if there is not information return false
      */
     public static function get_info_gradebook_certificate($course_code, $user_id)
@@ -4715,7 +4731,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     static function get_user_field_types()
     {
@@ -4967,7 +4983,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