chamilo / chamilo-lms

main/work/work.lib.php

Doc Comments +13 added lines, -11 removed lines

@@ -696,7 +696,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
  */
@@ -718,7 +718,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)
 {
@@ -861,7 +861,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)
 {
@@ -922,6 +922,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
@@ -991,7 +992,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
@@ -2724,7 +2725,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2998,6 +2999,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -4140,7 +4142,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4513,7 +4515,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4631,7 +4633,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4677,7 +4679,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4815,7 +4817,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -4929,7 +4931,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

src/Chamilo/CoreBundle/Entity/Session.php

Doc Comments +3 added lines, -3 removed lines

@@ -372,7 +372,7 @@ 
     }
 
     /**
-     * @param $courses
+     * @param ArrayCollection $courses
      */
     public function setCourses($courses)
     {
@@ -514,7 +514,7 @@ 
      * Set description
      *
      * @param string $description
-     * @return Groups
+     * @return Session
      */
     public function setDescription($description)
     {
@@ -847,7 +847,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getStatusList()
     {

src/Chamilo/PageBundle/Entity/User.php

Doc Comments +3 added lines, -3 removed lines

@@ -907,7 +907,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1284,7 +1284,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -2051,7 +2051,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {

src/Chamilo/UserBundle/Entity/User.php

Doc Comments +4 added lines, -4 removed lines

@@ -995,7 +995,7 @@ 
     /**
      * Get pictureUri
      *
-     * @return Media
+     * @return string
      */
     public function getPictureUri()
     {
@@ -1303,7 +1303,7 @@ 
     }
 
     /**
-     * @return Media
+     * @return string
      */
     public function getAvatar()
     {
@@ -2078,7 +2078,7 @@ 
       /**
      * Returns the user roles
      *
-     * @return array The roles
+     * @return string[] The roles
      */
     public function getRoles()
     {
@@ -2403,7 +2403,7 @@ 
     /**
      * Check if the user has the skill
      * @param Skill $skill The skill
-     * @return boolean
+     * @return boolean|null
      */
     public function hasSkill(Skill $skill)
     {

main/lp/learnpath.class.php

Doc Comments +25 added lines, -22 removed lines

@@ -87,7 +87,7 @@ 
      * @param   string $course Course code
      * @param   integer $lp_id
      * @param   integer $user_id
-     * @return  mixed True on success, false on error
+     * @return  boolean True on success, false on error
      */
     public function __construct($course, $lp_id, $user_id)
     {
@@ -491,7 +491,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1043,7 +1043,7 @@ 
      * @param	array $courseInfo
      * @param	integer	Learnpath ID
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
      */
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
     {
@@ -1182,7 +1182,7 @@ 
      * @param	integer	$id Elem ID (0 if first)
      * @param	integer	$remove Whether to remove the resource/data from the
      * system or leave it (default: 'keep', others 'remove')
-     * @return	integer	Number of elements moved
+     * @return	false|null	Number of elements moved
      * @todo implement resource removal
      */
     public function delete_item($id, $remove = 'keep')
@@ -1264,7 +1264,7 @@ 
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
      * @param   int     $max_time_allowed
      * @param   string  $url
-     * @return  boolean True on success, false on error
+     * @return  false|null True on success, false on error
      */
     public function edit_item(
         $id,
@@ -1783,7 +1783,7 @@ 
 
     /**
      * Gets the first element URL.
-     * @return	string	URL to load into the viewer
+     * @return	false|null	URL to load into the viewer
      */
     public function first()
     {
@@ -2297,6 +2297,7 @@ 
      * @param int $student_id
      * @param string Course code (optional)
      * @param int $sessionId
+     * @param string $courseCode
      * @return	bool
      */
     public static function is_lp_visible_for_student(
@@ -2594,7 +2595,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2627,7 +2628,7 @@ 
     /**
      * @param string $size
      * @param string $path_type
-     * @return bool|string
+     * @return string|false
      */
     public function get_preview_image_path($size = null, $path_type = 'web')
     {
@@ -2773,6 +2774,8 @@ 
      * Returns the XML DOM document's node
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
      * @param	string		The identifier to look for
+     * @param DOMNodeList $children
+     * @param string $id
      * @return	mixed		The reference to the element found with that identifier. False if not found
      */
     public function get_scorm_xml_node(& $children, $id)
@@ -3020,7 +3023,7 @@ 
     /**
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
      * used by get_html_toc() to be ready to display
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
      */
     public function get_toc()
     {
@@ -3156,7 +3159,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4062,7 +4065,7 @@ 
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
      * class, this might be redefined to allow several behaviours depending on the document type.
      * @param integer Resource ID
-     * @return boolean True on success, false otherwise
+     * @return boolean|null True on success, false otherwise
      */
     public function open($id)
     {
@@ -4191,7 +4194,7 @@ 
      * Can be used as abstract
      * @param	integer	$lp_id Learnpath id
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
-     * @return bool
+     * @return false|null
      */
     public static function toggle_publish($lp_id, $set_visibility = 'v')
     {
@@ -4276,7 +4279,7 @@ 
      * Make sure the results are saved with anoter method. This method should probably be
      * redefined in children classes.
      * To use a similar method  statically, use the create_new_attempt() method
-     * @return string URL to load in the viewer
+     * @return boolean URL to load in the viewer
      */
     public function restart()
     {
@@ -4354,6 +4357,7 @@ 
      * Saves the given item
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
+     * @param integer $item_id
      * @return	boolean
      */
     public function save_item($item_id = null, $from_outside = true)
@@ -4851,7 +4855,7 @@ 
 
     /**
      * Sets use_max_score
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
      * @return  boolean True on success / False on error
      */
     public function set_use_max_score($use_max_score = 1)
@@ -5254,6 +5258,7 @@ 
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
      *
      * @param string 'seriousgame', 'single' or 'multiple'
+     * @param string $mode
      * @return boolean
      * @author ndiechburg <noel@cblue.be>
      **/
@@ -5296,7 +5301,7 @@ 
     /**
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
      *
-     * @return boolean
+     * @return boolean|null
      * @author ndiechburg <noel@cblue.be>
      **/
     public function switch_attempt_mode()
@@ -5487,7 +5492,6 @@ 
     /**
      * Function that creates a html list of learning path items so that we can add audio files to them
      * @author Kevin Van Den Haute
-     * @param int $lp_id
      * @return string
      */
     public function overview()
@@ -6501,7 +6505,7 @@ 
     /**
      * Function that displays a list with al the resources that
      * could be added to the learning path
-     * @return string
+     * @return boolean
      */
     public function display_resources()
     {
@@ -10046,7 +10050,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10581,7 +10585,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10631,7 +10635,6 @@ 
     /**
      * Set whether this is a learning path with the possibility to subscribe
      * users or not
-     * @param int $subscribeUsers (0 = false, 1 = true)
      */
     public function setSubscribeUsers($value)
     {
@@ -10756,7 +10759,7 @@ 
 
     /**
      * Get the item of exercise type (evaluation type)
-     * @return array The final evaluation. Otherwise return false
+     * @return integer The final evaluation. Otherwise return false
      */
     public function getFinalEvaluationItem()
     {
@@ -10980,7 +10983,7 @@ 
     /**
      * Create a forum for this learning path
      * @param type $forumCategoryId
-     * @return int The forum ID if was created. Otherwise return false
+     * @return false|string The forum ID if was created. Otherwise return false
      */
     public function createForum($forumCategoryId)
     {

main/inc/lib/myspace.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -666,7 +666,6 @@ 
      * @param   int $sessionId  The session ID
      * @param   int $courseId   The course ID
      * @param   int $exerciseId The quiz ID
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
      * @return  string  HTML array of results formatted for gridJS
      * @author César Perales <cesar.perales@beeznest.com>, Beeznest Team
      */
@@ -1254,6 +1253,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1588,6 +1588,7 @@ 
      * @param int Number of items to select
      * @param string Column to order on
      * @param string Order direction
+     * @param integer $number_of_items
      * @return array Results
      */
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1608,7 +1609,6 @@ 
     /**
      * Fills in session reporting data
      *
-     * @param integer $user_id the id of the user
      * @param array $url_params additonal url parameters
      * @param array $row the row information (the other columns)
      * @return string html code
@@ -2239,6 +2239,7 @@ 
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
      * @version Dokeos 1.8.6
      * @since October 2008
+     * @param integer $number_of_items
      */
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
     {
@@ -2341,7 +2342,6 @@ 
     /**
      * Checks if there are repeted users in a given array
      * @param  array $usernames list of the usernames in the uploaded file
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
      * @return array with the $usernames array and the $user_array array
      * @author Julio Montoya Armas
      */
@@ -2516,6 +2516,7 @@ 
 
     /**
      * Adds missing user-information (which isn't required, like password, etc).
+     * @return integer
      */
     function complete_missing_data($user) {
         // 1. Generate a password if it is necessary.

main/inc/lib/usermanager.lib.php

Doc Comments +21 added lines, -13 removed lines

@@ -139,7 +139,7 @@ 
     /**
      * Validates the password
      *
-     * @param $encoded
+     * @param string $encoded
      * @param $raw
      * @param $salt
      * @return bool
@@ -156,7 +156,7 @@ 
      * @param string $raw
      * @param User   $user
      *
-     * @return bool
+     * @return string
      */
     public static function encryptPassword($raw, User $user)
     {
@@ -1012,6 +1012,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
@@ -1042,6 +1043,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
@@ -1058,6 +1060,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
@@ -1223,6 +1226,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)
@@ -1420,7 +1424,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
      */
@@ -1830,7 +1834,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)
@@ -1985,7 +1989,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
@@ -2090,7 +2094,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)
     {
@@ -2124,6 +2128,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(
@@ -2398,6 +2403,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)
@@ -2962,7 +2968,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')
     {
@@ -3043,7 +3049,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')
     {
@@ -3098,6 +3104,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)
@@ -3127,6 +3134,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)
@@ -3342,7 +3350,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)
     {
@@ -3439,7 +3447,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)
     {
@@ -4881,7 +4889,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_user_field_types()
     {
@@ -5173,7 +5181,7 @@ 
 
     /**
      * Get the boss user ID from a followed user id
-     * @param $userId
+     * @param integer $userId
      * @return bool
      */
     public static function getStudentBossList($userId)
@@ -5225,7 +5233,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

main/inc/lib/fileManage.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -39,8 +39,8 @@ 
  * Deletes a file or a directory
  *
  * @author - Hugues Peeters
- * @param  $file (String) - the path of file or directory to delete
- * @return boolean - true if the delete succeed, false otherwise.
+ * @param  string $file (String) - the path of file or directory to delete
+ * @return boolean|null - true if the delete succeed, false otherwise.
  * @see    - delete() uses check_name_exist() and removeDir() functions
  */
 function my_delete($file)
@@ -127,7 +127,7 @@ 
  * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
  * @param  string $file_path complete path of the file or the directory
  * @param  string $new_file_name new name for the file or the directory
- * @return boolean true if succeed, false otherwise
+ * @return string|false true if succeed, false otherwise
  * @see rename() uses the check_name_exist() and php2phps() functions
  */
 function my_rename($file_path, $new_file_name) {
@@ -174,7 +174,7 @@ 
  * @param  string $target the path of the new area
  * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
  * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
- * @return bool true if the move succeed, false otherwise.
+ * @return boolean|null true if the move succeed, false otherwise.
  * @see move() uses check_name_exist() and copyDirTo() functions
  */
 function move($source, $target, $forceMove = false, $moveContent = false)

main/inc/lib/skill.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -326,6 +326,7 @@ 
 
     /**
      * Gets an element
+     * @param integer $gradebook_id
      */
     public function get_skill_info($skill_id, $gradebook_id)
     {
@@ -544,7 +545,7 @@ 
      * Gets an element
      * @param int $id
      *
-     * @return array|mixed
+     * @return integer
      */
     public function get($id)
     {
@@ -885,7 +886,7 @@ 
     /**
      * Get user's skills
      *
-     * @param int $userId User's id
+     * @param integer $user_id User's id
      * @param bool $get_skill_data
      */
     public function get_user_skills($user_id, $get_skill_data = false)
@@ -1090,7 +1091,7 @@ 
      * @param bool return a flat array or not
      * @param int depth of the skills
      * @param bool filter status
-     * @return json
+     * @return string
      */
     public function get_skills_tree_json($user_id = null, $skill_id = null, $return_flat_array = false, $main_depth = 2, $filter_status = false)
     {