chamilo / chamilo-lms

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

main/inc/lib/CourseChatUtils.php

Doc Comments +2 added lines, -2 removed lines

@@ -1415,7 +1415,7 @@ 
 
     /**
      * Get the emoji list to include in chat
-     * @return array
+     * @return string[]
      */
     public static function getEmojisToInclude()
     {
@@ -1738,7 +1738,7 @@ 
 
     /**
      * Get the number of users connected in chat
-     * @return mixed
+     * @return integer
      */
     public function countUsersOnline()
     {

main/gradebook/lib/GradebookUtils.php

Doc Comments +1 added lines, -1 removed lines

@@ -732,7 +732,7 @@
     }
 
     /**
-     * @param null $course_code
+     * @param string $course_code
      * @param int $gradebook_model_id
      * @return mixed
      */

main/inc/lib/course.lib.php

Doc Comments +2 added lines, -1 removed lines

@@ -2269,7 +2269,7 @@ 
 
     /**
      * Creates a file called mysql_dump.sql in the course folder
-     * @param $course_code The code of the course
+     * @param string $course_code The code of the course
      * @todo Implementation for single database
      */
     public static function create_database_dump($course_code)
@@ -3620,6 +3620,7 @@ 
      *  class userportal-course-item.
      * @param int      User category id
      * @param bool      Whether to show the document quick-loader or not
+     * @param integer $user_category_id
      * @return string
      */
     public static function returnCoursesWithoutCategories($user_category_id, $load_dirs = false)

main/inc/lib/glossary.lib.php

Doc Comments +3 added lines, -3 removed lines

@@ -95,7 +95,7 @@ 
      *
      * @param array  $values  Array of title + description (name => $title, description => $comment)
      *
-     * @return mixed   Term id on success, false on failure
+     * @return false|string   Term id on success, false on failure
      *
      */
     public static function save_glossary($values, $showMessage = true)
@@ -448,7 +448,7 @@ 
 
     /**
      * Display the glossary terms in a list
-     * @return bool true
+     * @return string true
      */
     public static function displayGlossaryList()
     {
@@ -585,7 +585,7 @@ 
      * Update action icons column
      *
      * @param integer $glossary_id
-     * @param array   $url_params Parameters to use to affect links
+     * @param string   $url_params Parameters to use to affect links
      * @param array   $row The line of results from a query on the glossary table
      *
      * @return string HTML string for the action icons columns