chamilo / chamilo-lms

main/inc/lib/document.lib.php

Doc Comments +23 added lines, -18 removed lines

@@ -277,7 +277,7 @@ 
     /**
      *  @param string
      *  @param string
-     * 	@return true if the user is allowed to see the document, false otherwise
+     * 	@return boolean if the user is allowed to see the document, false otherwise
      * 	@author Sergio A Kessler, first version
      * 	@author Roan Embrechts, bugfix
      *  @todo not only check if a file is visible, but also check if the user is allowed to see the file??
@@ -1529,7 +1529,7 @@ 
      * Return true if the documentpath have visibility=1 as
      * item_property (you should use the is_visible_by_id)
      *
-     * @param string $document_path the relative complete path of the document
+     * @param string $doc_path the relative complete path of the document
      * @param array  $course the _course array info of the document's course
      * @param int
      * @param string
@@ -1615,6 +1615,8 @@ 
      * @param   int
      * @param   int
      * @param bool
+     * @param integer $session_id
+     * @param integer $user_id
      * @return  bool
      */
     public static function is_visible_by_id(
@@ -1966,7 +1968,7 @@ 
      * Remove default certificate
      * @param string $course_id The course code
      * @param int $default_certificate_id The document id of the default certificate
-     * @return void
+     * @return false|null
      */
     public static function remove_attach_certificate($course_id, $default_certificate_id)
     {
@@ -2101,6 +2103,7 @@ 
      * @param	bool  	is file or string html
      * @param	string	type (one of the app tools) - optional (otherwise takes the current item's type)
      * @param	int		level of recursivity we're in
+     * @param string $source_html
      * @return	array	List of file paths. An additional field containing 'local' or 'remote' helps determine
      * if the file should be copied into the zip or just linked
      */
@@ -2940,6 +2943,7 @@ 
 
     /**
      * Obtains the text inside the file with the right parser
+     * @param string $doc_path
      */
     public static function get_text_content($doc_path, $doc_mime)
     {
@@ -3191,6 +3195,7 @@ 
      * Shows a play icon next to the document title in the document list
      * @param int
      * @param string
+     * @param integer|null $i
      * @return string	html content
      */
     public static function generate_media_preview($i, $type = 'simple')
@@ -4089,7 +4094,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_web_odf_extension_list()
     {
@@ -4098,10 +4103,10 @@ 
 
     /**
      * Set of extension allowed to use Jodconverter
-     * @param $mode 'from'
+     * @param string $mode 'from'
      *              'to'
      *              'all'
-     * @param $format   'text'
+     * @param string $format   'text'
      *                  'spreadsheet'
      *                  'presentation'
      *                  'drawing'
@@ -4305,7 +4310,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_system_folders()
     {
@@ -4323,7 +4328,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getProtectedFolderFromStudent()
     {
@@ -4479,7 +4484,7 @@ 
      * Requires the ffmpeg lib. In ubuntu: sudo apt-get install ffmpeg
      * @param string $wavFile
      * @param bool $removeWavFileIfSuccess
-     * @return bool
+     * @return string|false
      */
     public static function convertWavToMp3($wavFile, $removeWavFileIfSuccess = false)
     {
@@ -5055,6 +5060,8 @@ 
      * @param string	The current folder (path inside of the "document" directory, including the prefix "/")
      * @param string	Group directory, if empty, prevents documents to be uploaded (because group documents cannot be uploaded in root)
      * @param	boolean	Whether to change the renderer (this will add a template <span> to the QuickForm object displaying the form)
+     * @param string $document_id
+     * @param FormValidator $form
 
      * @return string html form
      */
@@ -5560,9 +5567,6 @@ 
     /**
      * Creates the row of edit icons for a file/folder
      *
-     * @param string $curdirpath current path (cfr open folder)
-     * @param string $type (file/folder)
-     * @param string $path dbase path of file/folder
      * @param int $visibility (1/0)
      * @param int $id dbase id of the document
      * @return string html img tags with hyperlinks
@@ -5896,7 +5900,7 @@ 
     /**
      * Gets the path translated with title of docs and folders
      * @param string $path the real path
-     * @return the path which should be displayed
+     * @return string path which should be displayed
      */
     public static function get_titles_of_path($path)
     {
@@ -5952,7 +5956,8 @@ 
 
     /**
      * Checks whether the user is in shared folder
-     * @return return bool Return true when user is into shared folder
+     * @param integer $current_session_id
+     * @return boolean bool Return true when user is into shared folder
      */
     public static function is_shared_folder($curdirpath, $current_session_id)
     {
@@ -5968,7 +5973,7 @@ 
 
     /**
      * Checks whether the user is into any user shared folder
-     * @return return bool Return true when user is in any user shared folder
+     * @return boolean bool Return true when user is in any user shared folder
      */
     public static function is_any_user_shared_folder($path, $current_session_id)
     {
@@ -6182,7 +6187,7 @@ 
      * @param int $id
      * @param array $courseInfo
      * @param int $sessionId
-     * @return bool
+     * @return boolean|null
      */
     public static function downloadDeletedDocument($id, $courseInfo, $sessionId)
     {
@@ -6201,7 +6206,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function downloadAllDeletedDocument($courseInfo, $sessionId)
     {
@@ -6240,7 +6245,7 @@ 
      * @param array $courseInfo
      * @param int $sessionId
      *
-     * @return bool
+     * @return false|null
      */
     public static function deleteDocumentsFromSession($courseInfo, $sessionId)
     {

main/inc/lib/userportal.lib.php

Doc Comments +6 added lines, -5 removed lines

@@ -682,6 +682,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -732,8 +733,8 @@ 
 
     /**
      * @todo use the template system
-     * @param $title
-     * @param $content
+     * @param string|null $title
+     * @param string $content
      * @param string $id
      * @param array $params
      * @param string $idAccordion
@@ -1704,8 +1705,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1726,7 +1727,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string

main/lp/learnpathItem.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -1869,7 +1869,7 @@ 
 
     /**
      * Get the extra terms (tags) that identify this item
-     * @return mixed
+     * @return string
      */
     public function get_terms()
     {
@@ -2069,7 +2069,7 @@ 
 
     /**
      * Opens/launches the item. Initialises runtime values.
-     * @return    boolean    True on success, false on failure.
+     * @return    boolean|null    True on success, false on failure.
      */
     public function open($allow_new_attempt = false)
     {
@@ -3504,7 +3504,7 @@ 
 
     /**
      * Checks if the current status is part of the list of status given
-     * @param  array  $list  An array of status to check for.
+     * @param  string[]  $list  An array of status to check for.
      * If the current status is one of the strings, return true
      *
      * @return boolean True if the status was one of the given strings,
@@ -3681,7 +3681,7 @@ 
     /**
      * Write objectives to DB. This method is separate from write_to_db() because otherwise
      * objectives are lost as a side effect to AJAX and session concurrent access
-     * @return    boolean        True or false on error
+     * @return    boolean|null        True or false on error
      */
     public function write_objectives_to_db()
     {
@@ -4322,7 +4322,7 @@ 
      * Removes the relation between the current item and an audio file. The file
      * is only removed from the lp_item table, but remains in the document table
      * and directory
-     * @return bool
+     * @return false|null
      */
     public function remove_audio()
     {

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/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)