chamilo / chamilo-lms

main/lp/openoffice_text_document.class.php

Doc Comments +3 added lines, -1 removed lines

@@ -38,7 +38,7 @@ 
     /**
      * Gets html pages and compose them into a learning path
      * @param	array	The files that will compose the generated learning path. Unused so far.
-     * @return	boolean	False if file does not exit. Nothing otherwise.
+     * @return	false|null	False if file does not exit. Nothing otherwise.
      */
     public function make_lp($files = array())
     {
@@ -92,6 +92,7 @@ 
      * Manages chapter splitting
      * @param	string	Chapter header
      * @param	string	Content
+     * @param string $content
      * @return	void
      */
     function dealPerChapter($header, $content)
@@ -164,6 +165,7 @@ 
      * Manages page splitting
      * @param	string	Page header
      * @param	string	Page body
+     * @param string $body
      * @return	void
      */
     function dealPerPage($header, $body)

main/lp/scorm.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -271,7 +271,7 @@ 
      * @param int $userMaxScore
      * @param int $sessionId
      *
-     * @return bool	Returns -1 on error
+     * @return boolean|null	Returns -1 on error
      */
     public function import_manifest($courseCode, $userMaxScore = 1, $sessionId = 0, $userId = 0)
     {
@@ -925,7 +925,7 @@ 
      * @param	string	course Code
      * @param string	LP ID (in database)
      * @param string	Manifest file path (optional if lp_id defined)
-     * @return	integer	New LP ID or false on failure
+     * @return	boolean	New LP ID or false on failure
      * TODO @TODO Implement imsmanifest_path parameter
      */
     public function reimport_manifest($courseCode, $lp_id = null, $imsmanifest_path = '')

main/lp/resourcelinker.inc.php

Doc Comments +6 added lines, -2 removed lines

@@ -181,8 +181,8 @@ 
 /**
  * Inserts a resource into the database
  *
- * @param $source_type
- * @param $source_id
+ * @param string $source_type
+ * @param integer $source_id
  */
 function store_resources($source_type, $source_id)
 {
@@ -322,6 +322,10 @@ 
  * @param icon        - if ="icon" then the small icon will appear
  *                      if ="wrap" then wrapped settings are used (and no icon is displayed)
  *                      if ="nolink" then only the name is returned with no href and no icon (note:only in this case, the result is not displayed, but returned)
+ * @param string $completed
+ * @param string $id_in_path
+ * @param string $builder
+ * @param string $icon
  * @todo this function is too long, rewrite
  */
 function display_addedresource_link_in_learnpath($type, $id, $completed, $id_in_path, $builder, $icon, $level = 0) {

main/resourcelinker/resourcelinker.inc.php

Doc Comments +6 added lines, -2 removed lines

@@ -205,8 +205,8 @@ 
 /**
  * Inserts a resource into the database
  *
- * @param $source_type
- * @param $source_id
+ * @param string $source_type
+ * @param integer $source_id
  */
 function store_resources($source_type, $source_id)
 {
@@ -338,6 +338,10 @@ 
 * @param icon        - if ="icon" then the small icon will appear
 *                      if ="wrap" then wrapped settings are used (and no icon is displayed)
 *                      if ="nolink" then only the name is returned with no href and no icon (note:only in this case, the result is not displayed, but returned)
+* @param string $completed
+* @param string $id_in_path
+* @param string $builder
+* @param string $icon
 * @todo this function is too long, rewrite
 */
 function display_addedresource_link_in_learnpath($type, $id, $completed, $id_in_path, $builder, $icon, $level = 0)

main/lp/learnpath.class.php

Doc Comments +27 added lines, -24 removed lines

@@ -86,7 +86,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)
     {
@@ -488,7 +488,7 @@ 
      * @param int $max_time_allowed
      * @param int $userId
      *
-     * @return int
+     * @return false|string
      */
     public function add_item(
         $parent,
@@ -1039,7 +1039,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')
     {
@@ -1173,7 +1173,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')
@@ -1255,7 +1255,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,
@@ -1775,7 +1775,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()
     {
@@ -2291,6 +2291,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(
@@ -2588,7 +2589,7 @@ 
 
     /**
      * Gets the learnpath session id
-     * @return	string	Learnpath theme
+     * @return	integer	Learnpath theme
      */
     public function get_lp_session_id()
     {
@@ -2621,7 +2622,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')
     {
@@ -2767,6 +2768,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)
@@ -3014,7 +3017,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()
     {
@@ -3150,7 +3153,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getChapterTypes()
     {
@@ -4059,7 +4062,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)
     {
@@ -4188,7 +4191,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')
     {
@@ -4273,7 +4276,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()
     {
@@ -4351,6 +4354,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)
@@ -4848,7 +4852,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)
@@ -5251,6 +5255,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>
      **/
@@ -5293,7 +5298,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()
@@ -5484,7 +5489,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()
@@ -5904,7 +5908,7 @@ 
     /**
      * This function builds the action menu
      * @param bool $returnContent
-     * @return void
+     * @return string|null
      */
     public function build_action_menu($returnContent = false)
     {
@@ -6449,7 +6453,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()
     {
@@ -10030,7 +10034,7 @@ 
 
     /**
      * @param int $lp_id
-     * @return bool
+     * @return false|null
      */
     public function scorm_export_to_pdf($lp_id)
     {
@@ -10567,7 +10571,7 @@ 
 
     /**
      * @param int $itemId
-     * @return learnpathItem|false
+     * @return string
      */
     public function getItem($itemId)
     {
@@ -10617,7 +10621,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)
     {
@@ -10742,7 +10745,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()
     {
@@ -10966,7 +10969,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)
     {
@@ -11015,7 +11018,7 @@ 
     /**
      * Get the LP Final Item Template
      *
-     * @return html
+     * @return string
      */
     private function getFinalItemTemplate()
     {

main/work/work.lib.php

Doc Comments +16 added lines, -15 removed lines

@@ -692,7 +692,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
  */
@@ -714,7 +714,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)
 {
@@ -857,7 +857,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)
 {
@@ -914,6 +914,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
@@ -983,7 +984,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
@@ -2713,7 +2714,7 @@ 
  * @param int $userId
  * @param int $workId
  * @param int $courseId
- * @return bool
+ * @return boolean|null
  */
 function allowOnlySubscribedUser($userId, $workId, $courseId)
 {
@@ -2831,7 +2832,7 @@ 
 /**
  * Get total score from a work list
  * @param $workList
- * @return int|null
+ * @return integer
  */
 function getTotalWorkScore($workList)
 {
@@ -2847,7 +2848,7 @@ 
  * Get comment count from a work list (docs sent by students)
  * @param array $workList
  * @param array $courseInfo
- * @return int|null
+ * @return integer
  */
 function getTotalWorkComment($workList, $courseInfo = array())
 {
@@ -2985,6 +2986,7 @@ 
  * @param int $parentId
  * @param array $courseInfo
  * @param int $sessionId
+ * @param integer $userId
  * @return int
  */
 function getLastWorkStudentFromParentByUser(
@@ -3614,12 +3616,11 @@ 
 
 /**
  * Creates a new task (directory) in the assignment tool
- * @param array $params
  * @param int $user_id
  * @param array $courseInfo
  * @param int $group_id
  * @param int $session_id
- * @return bool|int
+ * @return string|false
  * @note $params can have the following elements, but should at least have the 2 first ones: (
  *       'new_dir' => 'some-name',
  *       'description' => 'some-desc',
@@ -4115,7 +4116,7 @@ 
 }
 
 /**
- * @return array
+ * @return string[]
  */
 function getUploadDocumentType()
 {
@@ -4488,7 +4489,7 @@ 
  * @param int Session ID
  * @param $correction
  *
- * @return array|bool
+ * @return boolean
  */
 function getFileContents($id, $course_info, $sessionId = 0, $correction = false)
 {
@@ -4606,7 +4607,7 @@ 
  * @param int $userId
  * @param array $courseInfo
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllWork($userId, $courseInfo, $format = 'pdf')
 {
@@ -4654,7 +4655,7 @@ 
  * @param array $courseInfo
  * @param int $sessionId
  * @param string $format
- * @return bool
+ * @return false|null
  */
 function exportAllStudentWorkFromPublication(
     $workId,
@@ -4792,7 +4793,7 @@ 
  * Downloads all user files per user
  * @param int $userId
  * @param array $courseInfo
- * @return bool
+ * @return false|null
  */
 function downloadAllFilesPerUser($userId, $courseInfo)
 {
@@ -4906,7 +4907,7 @@ 
 /**
  * @param array $courseInfo
  * @param int $workId
- * @return bool
+ * @return boolean|null
  */
 function protectWork($courseInfo, $workId)
 {

main/admin/settings.lib.php

Doc Comments +4 added lines, -3 removed lines

@@ -1154,7 +1154,7 @@ 
 /**
  * Returns an array containing the list of options used to populate the gradebook_number_decimals variable
  * This function is called through a call_user_func() in the generate_settings_form function.
- * @return array List of gradebook_number_decimals options
+ * @return string[] List of gradebook_number_decimals options
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
  */
@@ -1575,8 +1575,9 @@ 
 }
 /**
  * Helper function to generates a form elements group
- * @param object $form The form where the elements group has to be added
+ * @param FormValidator $form The form where the elements group has to be added
  * @param array $values Values to browse through
+ * @param string $elementName
  * @return array
  */
 function formGenerateElementsGroup($form, $values = array(), $elementName)
@@ -1592,7 +1593,7 @@ 
 }
 /**
  * Helper function with allowed file types for CSS
- * @return  array Array of file types (no indexes)
+ * @return  string[] Array of file types (no indexes)
  */
 function getAllowedFileTypes()
 {

main/inc/lib/attendance.lib.php

Doc Comments +23 added lines, -5 removed lines

@@ -277,7 +277,7 @@ 
      * Add attendances sheet inside table. This is the *list of* dates, not
      * a specific date in itself.
      * @param  bool   true for adding link in gradebook or false otherwise (optional)
-     * @return int    last attendance id
+     * @return false|string    last attendance id
      */
     public function attendance_add($link_to_gradebook = false)
     {
@@ -354,6 +354,7 @@ 
      * edit attendances inside table
      * @param 	int	   attendance id
      * @param  	bool   true for adding link in gradebook or false otherwise (optional)
+     * @param integer $attendance_id
      * @return 	int    last id
      */
     public function attendance_edit($attendance_id, $link_to_gradebook = false)
@@ -429,6 +430,7 @@ 
     /**
      * Restore attendance
      * @param 	int|array	   one or many attendances id
+     * @param integer $attendance_id
      * @return 	int    		   affected rows
      */
     public function attendance_restore($attendance_id)
@@ -530,7 +532,7 @@ 
 
     /**
      * Changes visibility
-     * @param int|array	$attendanceId   one or many attendances id
+     * @param integer	$attendanceId   one or many attendances id
      * @param int status
      *
      * @return 	int affected rows
@@ -585,6 +587,7 @@ 
      * Lock or unlock an attendance
      * @param   int     attendance id
      * @param   bool    True to lock or false otherwise
+     * @param integer $attendance_id
      */
     public function lock_attendance($attendance_id, $lock = true)
     {
@@ -917,7 +920,11 @@ 
      * @param   string  Event type ('locked_attendance', 'done_attendance_sheet' ...)
      * @param   int     Last edit user id
      * @param   string  Calendar datetime value (optional, when event type is 'done_attendance_sheet')
-     * @return  int     Affected rows
+     * @param integer $attendance_id
+     * @param string $lastedit_date
+     * @param string $lastedit_type
+     * @param integer $lastedit_user_id
+     * @return  false|string     Affected rows
      */
     public function save_attendance_sheet_log(
         $attendance_id,
@@ -962,6 +969,7 @@ 
     /**
      * Get number of done attendances inside current sheet
      * @param	int	   attendance id
+     * @param integer $attendance_id
      * @return 	int	   number of done attendances
      */
     public static function get_done_attendance_calendar($attendance_id)
@@ -1197,6 +1205,7 @@ 
     /**
      * Get next attendance calendar without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int attendance calendar id
      */
     public function get_next_attendance_calendar_id($attendance_id)
@@ -1225,6 +1234,7 @@ 
     /**
      * Get next attendance calendar datetime without presences (done attendances)
      * @param	int	attendance id
+     * @param integer $attendance_id
      * @return 	int UNIX time format datetime
      */
     public function get_next_attendance_calendar_datetime($attendance_id)
@@ -1253,6 +1263,7 @@ 
      * Get user' score from current attendance
      * @param	int	$user_id
      * @param	int $attendance_id
+     * @param integer $groupId
      * @return	int score
      */
     public function get_user_score($user_id, $attendance_id, $groupId = null)
@@ -1300,6 +1311,7 @@ 
     /**
      * Get attendance calendar data by id
      * @param	int	attendance calendar id
+     * @param integer $calendar_id
      * @return	array attendance calendar data
      */
     public function get_attendance_calendar_by_id($calendar_id)
@@ -1422,6 +1434,7 @@ 
      * Get number of attendance calendar inside current attendance
      * @param	int	$attendance_id
      * @param	int	$groupId
+     * @param boolean $done_attendance
      * @return	int number of dates in attendance calendar
      */
     public static function get_number_of_attendance_calendar($attendance_id, $groupId = 0, $done_attendance = NULL, $userId = 0)
@@ -1647,7 +1660,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      * @return array
      */
     public function getGroupListByAttendanceCalendar($calendarId, $courseId)
@@ -1687,7 +1699,6 @@ 
     /**
      * @param int $calendarId
      * @param int $courseId
-     * @param int $groupId
      *
      * @return array
      */
@@ -1788,6 +1799,8 @@ 
      * edit a datetime inside attendance calendar table
      * @param	int	attendance calendar id
      * @param	int	attendance id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_edit($calendar_id, $attendance_id)
@@ -1827,6 +1840,8 @@ 
      * @param	int		attendance calendar id
      * @param	int		attendance id
      * @param	bool	true for removing all calendar inside current attendance, false for removing by calendar id
+     * @param integer $calendar_id
+     * @param integer $attendance_id
      * @return	int affected rows
      */
     public function attendance_calendar_delete($calendar_id, $attendance_id , $all_delete = false)
@@ -1889,6 +1904,9 @@ 
         $this->course_id = $course_id;
     }
 
+    /**
+     * @param string $datetime
+     */
     public function set_date_time($datetime)
     {
         $this->date_time = $datetime;

main/inc/lib/event_email_template.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -84,7 +84,7 @@
 
     /**
      * Available driver list.
-     * @return array
+     * @return string[]
      */
     private function getDefaultDriverList()
     {