chamilo / chamilo-lms

main/inc/lib/link.lib.php

Doc Comments +4 added lines, -2 removed lines

@@ -856,8 +856,8 @@ 
 
     /**
      * @param integer $categoryId
-     * @param $courseId
-     * @param $sessionId
+     * @param integer $courseId
+     * @param integer $sessionId
      * @param bool $withBaseContent
      *
      * @return array
@@ -1485,6 +1485,7 @@ 
      * This function checks if the url is a vimeo link
      * @author Julio Montoya
      * @version 1.0
+     * @param string $url
      */
     public static function isVimeoLink($url)
     {
@@ -1519,6 +1520,7 @@ 
      * @author Jorge Frisancho
      * @author Julio Montoya - Fixing code
      * @version 1.0
+     * @param string $url
      */
     public static function is_youtube_link($url)
     {

main/inc/lib/ScheduledAnnouncement.php

Doc Comments +1 added lines, -1 removed lines

@@ -312,7 +312,7 @@
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getTags()
     {

main/inc/lib/sortable_table.class.php

Doc Comments +1 added lines

@@ -443,6 +443,7 @@
      * @param bool       hide navigation optionally
      * @param int        content per page when show navigation (optional)
      * @param bool       sort data optionally
+     * @param boolean $visibility_options
      * @return string    grid html
      */
     public function display_simple_grid(

main/lp/aiccItem.class.php

Doc Comments +1 added lines

@@ -34,6 +34,7 @@
      * object from database records or from the array given as second parameter
      * @param	string	Type of construction needed ('db' or 'config', default = 'config')
      * @param	mixed	Depending on the type given, DB id for the lp_item or parameters array
+     * @param integer $course_id
      */
     public function __construct($type = 'config', $params = array(), $course_id = null)
     {

main/inc/lib/internationalization.lib.php

Doc Comments +19 added lines, -13 removed lines

@@ -448,6 +448,7 @@ 
  * If null, the timezone will be determined based on user preference,
  * or timezone chosen by the admin for the platform.
  * @param string The timezone to be converted from. If null, UTC will be assumed.
+ * @param string $to_timezone
  * @return string The converted time formatted as Y-m-d H:i:s
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -719,6 +720,8 @@ 
  * @param mixed The time to be converted
  * @param mixed Format to be used (TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG)
  * @param string Timezone to be converted from. If null, UTC will be assumed.
+ * @param integer $format
+ * @param string $from_timezone
  * @return string Converted and localized date
  *
  * @author Guillaume Viguier <guillaume.viguier@beeznest.com>
@@ -805,7 +808,7 @@ 
  * This parameter has meaning with the format PERSON_NAME_COMMON_CONVENTION only.
  * @param string $encoding (optional)    The used internally by this function
  * character encoding. If it is omitted, the platform character set will be used by default.
- * @return bool The result is sort of full name of the person.
+ * @return string The result is sort of full name of the person.
  * Sample results:
  * Peter Ustinoff or Dr. Peter Ustinoff     - the Western order
  * Ustinoff Peter or Dr. Ustinoff Peter     - the Eastern order
@@ -1148,8 +1151,8 @@ 
 /**
  * This function returns a string or an array with all occurrences of search
  * in subject (ignoring case) replaced with the given replace value.
- * @param mixed $search String or array of strings to be found.
- * @param mixed $replace String or array of strings used for replacement.
+ * @param string $search String or array of strings to be found.
+ * @param string $replace String or array of strings used for replacement.
  * @param mixed $subject String or array of strings being searched.
  * @param int $count (optional) The number of matched and replaced needles
  * will be returned in count, which is passed by reference.
@@ -1219,12 +1222,12 @@ 
 /**
  * Finds first occurrence of a string within another, case insensitive.
  * @param string $haystack The string from which to get the first occurrence.
- * @param mixed $needle The string to be found.
+ * @param string $needle The string to be found.
  * @param bool $before_needle (optional) Determines which portion of $haystack
  * this function returns. The default value is FALSE.
  * @param string $encoding (optional) The used internally by this function
  * character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the
  * ordinal value (codepoint if the encoding is UTF-8) of a character.
@@ -1283,7 +1286,7 @@ 
  * @param mixed $needle The string which first character is to be found.
  * @param bool $before_needle (optional) Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional) The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
+ * @return false|string Returns the portion of $haystack, or FALSE if the first character from $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence.
@@ -1350,7 +1353,7 @@ 
  * @param mixed $needle The string to be found.
  * @param bool $before_needle (optional) Determines which portion of $haystack this function returns. The default value is FALSE.
  * @param string $encoding (optional) The used internally by this function character encoding. If it is omitted, the platform character set will be used by default.
- * @return mixed Returns the portion of $haystack, or FALSE if $needle is not found.
+ * @return false|string Returns the portion of $haystack, or FALSE if $needle is not found.
  * Notes:
  * If $needle is not a string, it is converted to an integer and applied as the ordinal value (codepoint if the encoding is UTF-8) of a character.
  * If $before_needle is set to TRUE, the function returns all of $haystack from the beginning to the first occurrence of $needle.
@@ -1540,8 +1543,8 @@ 
 
 /**
  * Performs a regular expression search and replace, UTF-8 aware when it is applicable.
- * @param string|array $pattern			The pattern to search for. It can be either a string or an array with strings.
- * @param string|array $replacement		The string or an array with strings to replace.
+ * @param string $pattern			The pattern to search for. It can be either a string or an array with strings.
+ * @param string $replacement		The string or an array with strings to replace.
  * @param string|array $subject			The string or an array with strings to search and replace.
  * @param int $limit					The maximum possible replacements for each pattern in each subject string. Defaults to -1 (no limit).
  * @param int &$count					If specified, this variable will be filled with the number of replacements done.
@@ -1692,7 +1695,7 @@ 
 
 /**
  * This function checks whether two $encoding are equal (same, equvalent).
- * @param string|array $encoding1		The first encoding
+ * @param string $encoding1		The first encoding
  * @param string|array $encoding2		The second encoding
  * @param bool $strict					When this parameter is TRUE the comparison ignores aliases of encodings.
  * When the parameter is FALSE, aliases are taken into account.
@@ -1800,7 +1803,7 @@ 
  * Checks a string for UTF-8 validity.
  * @param string $string
  *
- * @return string
+ * @return boolean
  */
 function api_is_valid_utf8($string)
 {
@@ -1974,7 +1977,7 @@ 
 /**
  * Replaces non-valid formats for person names with the default (English) format.
  * @param string $format The input format to be verified.
- * @return bool Returns the same format if is is valid, otherwise returns a valid English format.
+ * @return string Returns the same format if is is valid, otherwise returns a valid English format.
  */
 function _api_validate_person_name_format($format)
 {
@@ -2106,6 +2109,9 @@ 
 
 // This function checks whether the function _api_convert_encoding() (the php-
 // implementation) is able to convert from/to a given encoding.
+/**
+ * @param string $encoding
+ */
 function _api_convert_encoding_supports($encoding)
 {
     static $supports = array();
@@ -2117,7 +2123,7 @@ 
 
 /**
  * Given a date object, return a human or ISO format, with or without h:m:s
- * @param object $date The Date object
+ * @param DateTime $date The Date object
  * @param bool $showTime Whether to show the time and date (true) or only the date (false)
  * @param bool $humanForm Whether to show day-month-year (true) or year-month-day (false)
  * @return string Formatted date

main/wiki/wiki.inc.php

Doc Comments +14 added lines, -6 removed lines

@@ -292,7 +292,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)
     {
@@ -1503,6 +1503,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)
@@ -2034,6 +2035,7 @@ 
 
     /**
      * Sends pending e-mails
+     * @param string $type
      */
     public function check_emailcue(
         $id_or_ref,
@@ -2258,7 +2260,7 @@ 
     /**
      * Function export last wiki page version to document area
      * @param int $doc_id wiki page id
-     * @return mixed
+     * @return false|string
      * @author Juan Carlos Raña <herodoto@telefonica.net>
      */
     public function export2doc($doc_id)
@@ -2411,6 +2413,7 @@ 
 
     /**
      * Exports the wiki page to PDF
+     * @param string $course_code
      */
     public function export_to_pdf($id, $course_code)
     {
@@ -3084,6 +3087,7 @@ 
     /**
      * Draws an HTML form select with the given options
      *
+     * @param string $name
      */
     public function make_select($name, $values, $checked = '')
     {
@@ -3122,7 +3126,7 @@ 
     /**
      * Get wiki information
      * @param   int|bool wiki id
-     * @return  array   wiki data
+     * @return  string   wiki data
      */
     public function getWikiDataFromDb($id)
     {
@@ -3170,6 +3174,7 @@ 
      * Get wiki information
      * @param   string     wiki id
      * @param int $courseId
+     * @param string $title
      * @return  array   wiki data
      */
     public function getPageByTitle($title, $courseId = null)
@@ -3202,6 +3207,8 @@ 
      * @param int $courseId
      * @param string
      * @param string
+     * @param string $groupfilter
+     * @param string $condition_session
      * @return bool
      */
     public function deletePage(
@@ -4553,6 +4560,7 @@ 
 
     /**
      * Show all pages
+     * @param string $action
      */
     public function allPages($action)
     {
@@ -5446,7 +5454,7 @@ 
 
     /**
      * Restore page
-     * @return bool
+     * @return false|null
      */
     public function restorePage()
     {
@@ -5600,7 +5608,7 @@ 
     }
 
     /**
-     * @param int|bool $wikiId
+     * @param false|string $wikiId
      */
     public function setWikiData($wikiId)
     {
@@ -5618,7 +5626,7 @@ 
     /**
      * Check last version
      * @param int $view
-     * @return bool
+     * @return false|null
      */
     public function checkLastVersion($view)
     {

main/inc/lib/event_email_template.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -13 removed lines

@@ -18,7 +18,7 @@ 
      * @param string $url The URL of the site
      * @param string $description The description of the site
      * @param int $active is active or not
-     * @return boolean if success
+     * @return Doctrine\DBAL\Driver\Statement if success
     */
     public static function add($url, $description, $active)
     {
@@ -43,7 +43,7 @@ 
      * @param string $url
      * @param string $description The description of the site
      * @param int $active is active or not
-     * @return boolean if success
+     * @return Doctrine\DBAL\Driver\Statement if success
      */
     public static function update($url_id, $url, $description, $active)
     {
@@ -385,7 +385,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_user_exist($user_id, $url_id)
     {
@@ -403,7 +403,7 @@ 
     * @author Julio Montoya
     * @param int $courseId
     * @param int $urlId
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_course_exist($courseId, $urlId)
     {
@@ -424,7 +424,7 @@ 
      * @author Julio Montoya
      * @param int $userGroupId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
     {
@@ -444,7 +444,7 @@ 
     * @author Julio Montoya
     * @param int user id
     * @param int url id
-    * @return boolean true if success
+    * @return integer true if success
     * */
     public static function relation_url_session_exist($session_id, $url_id)
     {
@@ -567,6 +567,8 @@ 
      * @author Julio Montoya
      * @param  array of course ids
      * @param  array of url_ids
+     * @param integer[] $courseCategoryList
+     * @param integer[] $urlList
      * @return array
      **/
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -597,7 +599,7 @@ 
      * @author Julio Montoya
      * @param int $categoryCourseId
      * @param int $urlId
-     * @return boolean true if success
+     * @return integer true if success
      * */
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
     {
@@ -615,7 +617,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -717,7 +719,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -808,7 +810,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -826,7 +828,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -845,7 +847,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -864,8 +866,9 @@ 
     * @author Julio Montoya
     * @param  char  course code
     * @param  int url id
+    * @param integer $url_id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {

main/webservices/cm_webservice.php

Doc Comments +5 added lines, -2 removed lines

@@ -42,6 +42,8 @@ 
      *
      * @param int Error code
      * @param string Error message
+     * @param integer $code
+     * @param string $message
      */
     public function __construct($code, $message)
     {
@@ -91,6 +93,7 @@ 
      * Handle method
      *
      * @param WSError $error Error
+     * @return void
      */
     public function handle($error);
 }
@@ -119,7 +122,7 @@ 
      * Verifies the API key
      *
      * @param string $secret_key Secret key
-     * @return mixed WSError in case of failure, null in case of success
+     * @return WSCMError|null WSError in case of failure, null in case of success
      */
     protected function verifyKey($secret_key)
     {
@@ -145,7 +148,7 @@ 
      * @param string $username of the user in chamilo
      * @param string $pass of the same user (in MD5 of SHA)
      *
-     * @return mixed "valid" if username e password are correct! Else, return a message error
+     * @return string "valid" if username e password are correct! Else, return a message error
      */
     public function verifyUserPass($username, $pass)
     {