chamilo / chamilo-lms

main/inc/lib/fileUpload.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -17,6 +17,7 @@ 
  *
  * @author - Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  - file_name (string) name of a file
+ * @param string $file_name
  * @return - the filenam phps'ized
  */
 function php2phps($file_name) {
@@ -73,7 +74,7 @@ 
  * Returns the name without extension, used for the title
  *
  * @param string $name
- * @return name without the extension
+ * @return string without the extension
  */
 function get_document_title($name) {
     // If they upload .htaccess...
@@ -86,7 +87,7 @@ 
  * This function checks if the upload succeeded
  *
  * @param array $uploaded_file ($_FILES)
- * @return true if upload succeeded
+ * @return boolean if upload succeeded
  */
 function process_uploaded_file($uploaded_file, $show_output = true)
 {
@@ -738,6 +739,8 @@ 
  * @param  - dir (string) - Path of the directory
  *           whe the file should be added
  * @param  - max_dir_space (int) - maximum size of the diretory in byte
+ * @param string $dir
+ * @param integer $max_dir_space
  * @return - boolean true if there is enough space,
  *				boolean false otherwise
  *
@@ -1062,7 +1065,7 @@ 
  * @param array  $courseInfo
  * @param array  $userInfo
  * @param array  $uploaded_file - follows the $_FILES Structure
- * @param string $upload_path   - destination of the upload.
+ * @param string $uploadPath   - destination of the upload.
  *                               This path is to append to $base_work_dir
  * @param string $base_work_dir  - base working directory of the module
  * @param int    $maxFilledSpace  - amount of bytes to not exceed in the base
@@ -1243,7 +1246,7 @@ 
  * @param int $session_id Session ID, if any
  * @param int $userId creator id
  *
- * @return int id if inserted document
+ * @return string|false id if inserted document
  */
 function add_document(
     $_course,
@@ -1377,7 +1380,7 @@ 
  *
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path+filename eg: /main/document/document.php
- * @return	The directory depth
+ * @return	integer directory depth
  */
 function get_levels($filename) {
     $levels = explode('/', $filename);
@@ -1394,6 +1397,7 @@ 
  * @author	Olivier Cauberghe <olivier.cauberghe@ugent.be>
  * @param	path,filename
  * action:	Adds an entry to the document table with the default settings.
+ * @param string $upload_path
  */
 function set_default_settings($upload_path, $filename, $filetype = 'file')
 {
@@ -1818,6 +1822,7 @@ 
 
 @author Roan Embrechts
 @version 0.6
+ * @param string $buffer
  */
 function api_replace_links_in_string($upload_path, $buffer) {
     // Search for hyperlinks
@@ -2053,7 +2058,6 @@ 
  * @param int $groupId
  * @param bool $output
  * @param array $parent
- * @param string $uploadPath
  *
  */
 function add_all_documents_in_folder_to_database(

main/inc/lib/pear/HTML/QuickForm/checkbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -234,7 +234,7 @@
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function onQuickFormEvent($event, $arg, &$caller)
     {

main/inc/lib/pear/HTML/QuickForm/image.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * Freeze the element so that only its value is returned
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function freeze()
     {

main/inc/lib/pear/HTML/QuickForm/reset.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * Freeze the element so that only its value is returned
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function freeze()
     {

main/inc/lib/pear/HTML/QuickForm/static.php

Doc Comments +1 added lines, -1 removed lines

@@ -161,7 +161,7 @@
      * @param     object    &$caller calling object
      * @since     1.0
      * @access    public
-     * @return    void
+     * @return    boolean
      * @throws
      */
     function onQuickFormEvent($event, $arg, &$caller)

main/inc/lib/pear/HTML/QuickForm/submit.php

Doc Comments +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
      * Freeze the element so that only its value is returned
      *
      * @access    public
-     * @return    void
+     * @return    boolean
      */
     function freeze()
     {

main/inc/lib/pear/HTML/Table/Storage.php

Doc Comments +2 added lines, -3 removed lines

@@ -165,7 +165,7 @@ 
     /**
      * Returns the autoFill value
      * @access   public
-     * @return   mixed
+     * @return   string
      */
     public function getAutoFill()
     {
@@ -174,7 +174,6 @@ 
 
     /**
      * Sets the autoGrow value
-     * @param    bool   $fill
      * @access   public
      */
     public function setAutoGrow($grow)
@@ -185,7 +184,7 @@ 
     /**
      * Returns the autoGrow value
      * @access   public
-     * @return   mixed
+     * @return   boolean
      */
     public function getAutoGrow()
     {

main/inc/lib/pear/Pager/Sliding.php

Doc Comments +1 added lines, -1 removed lines

@@ -112,7 +112,7 @@
      *
      * @param integer $pageid PageID to get offsets for
      *
-     * @return array  First and last offsets
+     * @return integer[]  First and last offsets
      * @access public
      */
     function getPageRangeByPageId($pageid = null)

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)
     {
@@ -960,6 +960,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
@@ -990,6 +991,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
@@ -1006,6 +1008,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
@@ -1170,6 +1173,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)
@@ -1375,7 +1379,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
      */
@@ -1746,7 +1750,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)
     {
@@ -1782,7 +1786,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)
@@ -1937,7 +1941,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
@@ -2042,7 +2046,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)
     {
@@ -2076,6 +2080,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(
@@ -2262,7 +2267,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
@@ -2307,6 +2311,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)
@@ -2865,7 +2870,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')
     {
@@ -2945,7 +2950,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')
     {
@@ -3000,6 +3005,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)
@@ -3029,6 +3035,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)
@@ -3240,7 +3247,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)
     {
@@ -3285,6 +3293,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)
@@ -3331,7 +3341,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)
     {
@@ -4151,7 +4161,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, $deleteUsersBeforeInsert = false)
     {
@@ -4216,6 +4226,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)
@@ -4288,6 +4300,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)
@@ -4310,6 +4324,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)
@@ -4773,7 +4789,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     static function get_user_field_types()
     {
@@ -5093,7 +5109,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