chamilo / chamilo-lms

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()
     {

main/inc/lib/events_dispatcher.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     }
 
     /**
-     * @return bool
+     * @return false|null
      */
     public function create_user_folder()
     {

main/inc/lib/extra_field_option.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -412,7 +412,7 @@ 
      * Gets an array of options for a specific field
      * @param int $field_id The field ID
      * @param bool $add_id_in_array Whether to add the row ID in the result
-     * @param null $ordered_by Extra ordering query bit
+     * @param null|string $ordered_by Extra ordering query bit
      * @return array The options if they exists. Otherwise return false
      */
     public function get_field_options_by_field($field_id, $add_id_in_array = false, $ordered_by = null)
@@ -782,8 +782,8 @@ 
     }
 
     /**
-     * @param $defaultDisplayText
-     * @return mixed|string
+     * @param string $defaultDisplayText
+     * @return string
      */
     public static function getLanguageVariable($defaultDisplayText)
     {

main/inc/lib/formvalidator/FormValidator.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -954,7 +954,7 @@
     /**
      * This function has been created for avoiding changes directly within QuickForm class.
      * When we use it, the element is threated as 'required' to be dealt during validation.
-     * @param array $element The array of elements
+     * @param array $elements The array of elements
      * @param string $message The message displayed
      */
     public function add_multiple_required_rule($elements, $message)

main/inc/lib/icalcreator/iCalcreator.class.php

Doc Comments +24 added lines, -27 removed lines

@@ -136,7 +136,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-21
      * @param string $value
-     * @return void
+     * @return false|null
      */
     function setCalscale( $value ) {
         if( empty( $value )) return FALSE;
@@ -272,7 +272,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-23
      * @param string $value
-     * @return void
+     * @return boolean
      */
     function setVersion( $value ) {
         if( empty( $value )) return FALSE;
@@ -324,7 +324,7 @@ 
      * @since 2.4.11 - 2008-11-04
      * @param string $label
      * @param string $value
-     * @param array $params optional
+     * @param null|string $params optional
      * @return bool
      */
     function setXprop($label, $value, $params = array()) {
@@ -450,7 +450,7 @@ 
      * @param mixed  variable number of function arguments,
      *                    first argument is ALWAYS component name,
      *                    second ALWAYS component value!
-     * @return bool
+     * @return null|boolean
      */
     function setProperty () {
         $numargs    = func_num_args();
@@ -478,7 +478,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.10 - 2008-10-23
      * @param string $config
-     * @return value
+     * @return string
      */
     function getConfig( $config ) {
         switch( strtoupper( $config )) {
@@ -699,7 +699,7 @@ 
      * @since 2.4.10 - 2008-08-05
      * @param mixed $arg1 ordno / component type / component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function deleteComponent( $arg1, $arg2=FALSE  ) {
         $argType = $index = null;
@@ -1058,7 +1058,7 @@ 
      * @param object $component calendar component
      * @param mixed $arg1 optional, ordno/component type/ component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function setComponent( $component, $arg1=FALSE, $arg2=FALSE  ) {
         if( '' >= $component->getConfig( 'language'))
@@ -1607,7 +1607,7 @@ 
      * @param string $filename optional
      * @param string $delimiter optional
      * @param int timeout optional, default 3600 sec
-     * @return mixed
+     * @return false|null
      */
     function useCachedCalendar($directory=FALSE, $filename=FALSE, $delimiter=FALSE, $timeout=3600) {
         if ( $directory && ctype_digit( (string) $directory ) && !$filename ) {
@@ -2310,7 +2310,7 @@ 
      * @param int $min optional
      * @param int $sec optional
      * @param array $params optional
-     * @return TRUE
+     * @return boolean
      */
     function setDtstamp( $year, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
         if( empty( $year ))
@@ -2796,7 +2796,7 @@ 
      * @param int $min optional
      * @param int $sec optional
      * @param array $params optional
-     * @return boll
+     * @return boolean
      */
     function setLastModified( $year=FALSE, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
         if( empty( $year ))
@@ -3217,7 +3217,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.1 - 2008-11-07
-     * @param float $relid
      * @param array $params optional
      * @param index $index optional
      * @return bool
@@ -3255,7 +3254,7 @@ 
      * @since 2.4.8 - 2008-11-04
      * @param string $value
      * @param array $params optional
-     * @return void
+     * @return boolean
      */
     function setRepeat( $value, $params=FALSE ) {
         if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3378,7 +3377,7 @@ 
      * @param array $rruleset
      * @param array $params optional
      * @param integer $index optional
-     * @return void
+     * @return boolean
      */
     function setRrule( $rruleset, $params=FALSE, $index=FALSE ) {
         if( empty( $rruleset )) if( $this->getConfig( 'allowEmpty' )) $rruleset = null; else return FALSE;
@@ -3804,7 +3803,7 @@ 
      * @since 2.4.8 - 2008-11-04
      * @param string $value
      * @param string $params optional
-     * @return boll
+     * @return boolean
      */
     function setTzurl( $value, $params=FALSE ) {
         if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3933,7 +3932,7 @@ 
      * @param string $label
      * @param mixed $value
      * @param array $params optional
-     * @return bool
+     * @return null|boolean
      */
     function setXprop( $label, $value, $params=FALSE ) {
         if( empty( $label )) return;
@@ -4100,7 +4099,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 0.9.22 - 2007-04-10
      * @param array $params  optional
-     * @param array $ctrKeys optional
+     * @param string[] $ctrKeys optional
      * @return string
      */
     function _createParams( $params=array(), $ctrKeys=array() ) {
@@ -4142,7 +4141,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.16 - 2008-10-25
-     * @param array $date date to check
      * @param int $parno no of date parts (i.e. year, month.. .)
      * @return array $params property parameters
      */
@@ -4198,7 +4196,6 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.2.11 - 2007-11-03
      * @param array $startdate optional
-     * @param array $duration optional
      * @return array duration
      */
     function _date2duration( $startdate=FALSE, $enddate=FALSE ) {
@@ -4232,7 +4229,7 @@ 
      * @since 2.4.8 - 2008-10-30
      * @param array  $datetime  datetime/(date)
      * @param string $tz        timezone
-     * @return timestamp
+     * @return integer
      */
     function _date2timestamp( $datetime, $tz=null ) {
         $output = null;
@@ -4691,7 +4688,7 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-22
-     * @param array $recurlabel
+     * @param string $recurlabel
      * @param array $recurdata
      * @return string
      */
@@ -5231,6 +5228,10 @@ 
         else
             return FALSE;
     }
+
+    /**
+     * @param integer $wkst
+     */
     function _recurIntervalIx( $freq, $date, $wkst ) {
         /* create interval index */
         switch( $freq ) {
@@ -5539,7 +5540,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.16 - 2008-10-19
-     * @param string $offset
      * @return integer
      */
     function _tz2offset( $tz ) {
@@ -6195,9 +6195,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.1 - 2008-11-05
-     * @param mixed $args variable number of function arguments,
-     *                    first argument is ALWAYS component name,
-     *                    second ALWAYS component value!
      * @return void
      */
     function setProperty() {
@@ -6311,7 +6308,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.2 - 2008-10-23
      * @param mixed $unparsedtext optional, strict rfc2445 formatted, single property string or array of property strings
-     * @return bool FALSE if error occurs during parsing
+     * @return boolean|null FALSE if error occurs during parsing
      *
      */
     function parse( $unparsedtext=null ) {
@@ -6613,7 +6610,7 @@ 
      * @since 2.5.1 - 2008-10-15
      * @param mixed $arg1 ordno / component type / component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function deleteComponent( $arg1, $arg2=FALSE  ) {
         if( !isset( $this->components )) return FALSE;
@@ -6816,7 +6813,7 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.2.8 - 2006-09-03
-     * @param string $value
+     * @param string $string
      * @return string
      */
     function _size75( $string ) {

main/wiki/wiki.inc.php

Doc Comments +12 added lines, -4 removed lines

@@ -258,7 +258,7 @@ 
      * This function saves a change in a wiki page
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      * @param array $values
-     * @return language string saying that the changes are stored
+     * @return string string saying that the changes are stored
      **/
     public function save_wiki($values)
     {
@@ -1196,6 +1196,7 @@ 
      * Checks if this navigation tab has to be set to active
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University
      *
+     * @param string $paramwk
      * @return string html code
      */
     public function is_active_navigation_tab($paramwk)
@@ -1711,6 +1712,7 @@ 
 
     /**
      * Sends pending e-mails
+     * @param string $type
      */
     public function check_emailcue($id_or_ref, $type, $lastime='', $lastuser='')
     {
@@ -2011,6 +2013,7 @@ 
 
     /**
      * Exports the wiki page to PDF
+     * @param string $course_code
      */
     public function export_to_pdf($id, $course_code)
     {
@@ -2478,6 +2481,7 @@ 
     /**
      * Draws an HTML form select with the given options
      *
+     * @param string $name
      */
     public function make_select($name,$values,$checked='')
     {
@@ -2514,7 +2518,7 @@ 
     /**
      * Get wiki information
      * @param   int|bool     wiki id
-     * @return  array   wiki data
+     * @return  string   wiki data
      */
     public function getWikiDataFromDb($id)
     {
@@ -2561,6 +2565,7 @@ 
      * Get wiki information
      * @param   string     wiki id
      * @param int $courseId
+     * @param string $title
      * @return  array   wiki data
      */
     public function getPageByTitle($title, $courseId = null)
@@ -2593,6 +2598,8 @@ 
      * @param int $courseId
      * @param string
      * @param string
+     * @param string $groupfilter
+     * @param string $condition_session
      * @return bool
      */
     public function deletePage($title, $courseId, $groupfilter = null, $condition_session = null)
@@ -3644,6 +3651,7 @@ 
 
     /**
      * Show all pages
+     * @param string $action
      */
     public function allPages($action)
     {
@@ -4200,7 +4208,7 @@ 
 
     /**
      * Restore page
-     * @return bool
+     * @return false|null
      */
     public function restorePage()
     {
@@ -4302,7 +4310,7 @@ 
     }
 
     /**
-     * @param int|bool $wikiId
+     * @param false|string $wikiId
      */
     public function setWikiData($wikiId)
     {