chamilo / chamilo-lms

main/inc/lib/agenda.lib.php

Doc Comments +9 added lines, -4 removed lines

@@ -554,13 +554,12 @@ 
      * @param string $title
      * @param string $content
      * @param array $usersToSend
-     * @param int $editRepeatType
      * @param array $attachmentArray
      * @param string $attachmentComment
      * @param string $comment
      * @param string $color
      *
-     * @return bool
+     * @return null|false
      */
     public function editEvent(
         $id,
@@ -1292,6 +1291,7 @@ 
      *
      * @param int $eventId
      * @param int $courseId
+     * @param integer $sessionId
      * @paraù int $sessionId
      *
      * @return array
@@ -2284,6 +2284,7 @@ 
      * @param array $fileUserUpload ($_FILES['user_upload'])
      * @param string comment about file
      * @param array $courseInfo
+     * @param string $comment
      * @return string
      */
     public function addAttachment($eventId, $fileUserUpload, $comment, $courseInfo)
@@ -2403,6 +2404,7 @@ 
      * Adds x weeks to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of weeks to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addWeek($timestamp, $num = 1)
@@ -2414,6 +2416,7 @@ 
      * Adds x months to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of years to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addMonth($timestamp, $num = 1)
@@ -2432,6 +2435,7 @@ 
      * Adds x years to a UNIX timestamp
      * @param   int     The timestamp
      * @param   int     The number of years to add
+     * @param integer $timestamp
      * @return  int     The new timestamp
      */
     function addYear($timestamp, $num = 1)
@@ -2631,7 +2635,7 @@ 
     /**
      * @param array $courseInfo
      * @param $file
-     * @return array|bool|string
+     * @return false|string
      */
     public function importEventFile($courseInfo, $file)
     {
@@ -2744,7 +2748,7 @@ 
 
     /**
      * Parse filter turns USER:12 to ['users' => [12])] or G:1 ['groups' => [1]]
-     * @param $filter
+     * @param integer $filter
      * @return array
      */
     public function parseAgendaFilter($filter)
@@ -3259,6 +3263,7 @@ 
      * @param	int		user ID of the user
      * @param	string	Optional start date in datetime format (if no start date is given, uses today)
      * @param	string	Optional end date in datetime format (if no date is given, uses one year from now)
+     * @param integer $user_id
      * @return	array	Array of events ordered by start date, in
      * [0]('datestart','dateend','title'),[1]('datestart','dateend','title','link','coursetitle') format,
      * where datestart and dateend are in yyyyMMddhhmmss format.

main/inc/lib/AnnouncementEmail.php

Doc Comments +2 added lines, -2 removed lines

@@ -16,7 +16,7 @@ 
     /**
      *
      * @param int|array $course
-     * @param int|array $annoucement
+     * @param integer $announcement
      *
      * @return AnnouncementEmail
      */
@@ -50,7 +50,7 @@ 
      *
      * @param string $key
      *
-     * @return array
+     * @return string|null
      */
     public function course($key = '')
     {

main/inc/lib/AnnouncementManager.php

Doc Comments +9 added lines, -5 removed lines

@@ -18,7 +18,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function get_tags()
     {
@@ -40,7 +40,7 @@ 
      * @param string    $course_code
      * @param int       $session_id
      *
-     * @return mixed
+     * @return string
      */
     public static function parse_content($userId, $content, $course_code, $session_id = 0)
     {
@@ -349,7 +349,7 @@ 
      * @param array	    uploaded file $_FILES
      * @param string    Comment describing the attachment
      * @param bool  $sendToUsersInSession
-     * @return int      false on failure, ID of the announcement on success
+     * @return false|string      false on failure, ID of the announcement on success
      */
     public static function add_announcement(
         $emailTitle,
@@ -460,7 +460,7 @@ 
      * @param $to_users
      * @param array $file
      * @param string $file_comment
-     * @return bool|int
+     * @return false|string
      */
     public static function add_group_announcement(
         $emailTitle,
@@ -699,7 +699,7 @@ 
 
     /**
      * @param int $insert_id
-     * @return bool
+     * @return false|null
      */
     public static function update_mail_sent($insert_id)
     {
@@ -719,6 +719,7 @@ 
      * Gets all announcements from a user by course
      * @param	string course db
      * @param	int user id
+     * @param integer $user_id
      * @return	array html with the content and count of announcements or false otherwise
      */
     public static function get_all_annoucement_by_user_course($course_code, $user_id)
@@ -1184,6 +1185,7 @@ 
      * has been sent to
      * @param    string  The tool (announcement, agenda, ...)
      * @param    int     ID of the element of the corresponding type
+     * @param string $tool
      * @return   array   Array of users and groups to whom the element has been sent
      */
     public static function sent_to($tool, $id)
@@ -1308,6 +1310,8 @@ 
      * @param int attach id
      * @param array uploaded file $_FILES
      * @param string file comment
+     * @param integer $id_attach
+     * @param string $file_comment
      * @return int
      */
     public static function edit_announcement_attachment_file($id_attach, $file, $file_comment)

main/inc/lib/api.lib.php

Doc Comments +53 added lines, -25 removed lines

@@ -575,7 +575,6 @@ 
  * Also, this function provides conversion between path types, in this case the input path points inside the Chamilo area too.
  *
  * See $_configuration['course_folder'] in the configuration.php to alter the WEB_COURSE_PATH and SYS_COURSE_PATH parameters.
- * @param string $type              The requested path type (a defined constant), see the examples.
  * @param string $path (optional)   A path which type is to be converted. Also, it may be a defined constant for a path.
  * This parameter has meaning when $type parameter has one of the following values: TO_WEB, TO_SYS, TO_REL. Otherwise it is ignored.
  * @return string                   The requested path or the converted path.
@@ -1070,7 +1069,7 @@ 
  * Checks the RFC 3986 syntax of a given URL.
  * @param string $url       The URL to be checked.
  * @param bool $absolute    Whether the URL is absolute (beginning with a scheme such as "http:").
- * @return bool             Returns the URL if it is valid, FALSE otherwise.
+ * @return string|false             Returns the URL if it is valid, FALSE otherwise.
  * This function is an adaptation from the function valid_url(), Drupal CMS.
  * @link http://drupal.org
  * Note: The built-in function filter_var($urs, FILTER_VALIDATE_URL) has a bug for some versions of PHP.
@@ -1650,6 +1649,7 @@ 
  * Gets a course setting from the current course_setting table. Try always using integer values.
  * @param string    The name of the setting we want from the table
  * @param string    Optional: course code
+ * @param string $setting_name
  * @return mixed    The value of that setting in that table. Return -1 if not found.
  */
 function api_get_course_setting($setting_name, $course_code = null)
@@ -1960,7 +1960,7 @@ 
 /**
  * Checks a password to see wether it is OK to use.
  * @param string $password
- * @return true if the password is acceptable, false otherwise
+ * @return boolean if the password is acceptable, false otherwise
  * Notes about what a password "OK to use" is:
  * 1. The password should be at least 5 characters long.
  * 2. Only English letters (uppercase or lowercase, it doesn't matter) and digits are allowed.
@@ -2132,7 +2132,7 @@ 
      * @author Hugues Peeters <peeters@ipm.ucl.ac.be>
      * @param  string $failure_type - the type of failure
      * @global array  $api_failureList
-     * @return bolean false to stay consistent with the main script
+     * @return boolean false to stay consistent with the main script
      */
     static function set_failure($failure_type) {
         global $api_failureList;
@@ -3199,8 +3199,8 @@ 
 
 /**
 * Checks whether the user is allowed in a specific tool for a specific action
-* @param $tool the tool we are checking if the user has a certain permission
-* @param $action the action we are checking (add, edit, delete, move, visibility)
+* @param string $tool the tool we are checking if the user has a certain permission
+* @param string $action the action we are checking (add, edit, delete, move, visibility)
 * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
 * @author Julio Montoya
 * @version 1.0
@@ -3499,7 +3499,7 @@ 
 /**
  * Gets a UNIX timestamp from a database (MySQL) datetime format string
  * @param $last_post_datetime standard output date in a sql query
- * @return unix timestamp
+ * @return integer timestamp
  * @author Toon Van Hoecke <Toon.VanHoecke@UGent.be>
  * @version October 2003
  * @desc convert sql date to unix timestamp
@@ -3532,6 +3532,9 @@ 
  * @param string    Tool (learnpath, document, etc)
  * @param int       The item ID in the given tool
  * @param int       The session ID (optional)
+ * @param string $tool
+ * @param integer $user_id
+ * @param string $type
  * @return int      -1 on error, 0 if invisible, 1 if visible
  */
 function api_get_item_visibility(
@@ -3600,7 +3603,7 @@ 
  * @param int $userId
  * @param int $groupId
  * @param int $sessionId
- * @return void
+ * @return false|null
  */
 function api_item_property_delete(
     $courseInfo,
@@ -3655,7 +3658,7 @@ 
  * @param array $_course array with course properties
  * @param string $tool tool id, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int $item_id id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
- * @param string $lastedit_type add or update action
+ * @param string $last_edit_type add or update action
  * (1) message to be translated (in trad4all) : e.g. DocumentAdded, DocumentUpdated;
  * (2) "delete"
  * (3) "visible"
@@ -3938,6 +3941,8 @@ 
  * @param string    tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int       id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  * @param int $session_id
+ * @param string $tool
+ * @param string $course_code
  * @return array All fields from c_item_property (all rows found) or empty array
  */
 function api_get_item_property_by_tool($tool, $course_code, $session_id = null)
@@ -4107,6 +4112,7 @@ 
  * @param string    tool name, linked to 'rubrique' of the course tool_list (Warning: language sensitive !!)
  * @param int       id of the item itself, linked to key of every tool ('id', ...), "*" = all items of the tool
  * @param int $session_id
+ * @param string $tool
  * @return array Array with all fields from c_item_property, empty array if not found or false if course could not be found
  */
 function api_get_item_property_info($course_id, $tool, $ref, $session_id = 0)
@@ -4192,7 +4198,7 @@ 
  * Displays a form (drop down menu) so the user can select his/her preferred language.
  * The form works with or without javascript
  * @param  boolean Hide form if only one language available (defaults to false = show the box anyway)
- * @return void Display the box directly
+ * @return null|string Display the box directly
  */
 function api_display_language_form($hide_if_no_choice = false)
 {
@@ -4470,6 +4476,7 @@ 
  * and also when a user subscribes to courses (the new course is added at the end of the main category
  * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
  * @param int $user_course_category: the id of the user_course_category
+ * @param integer $user_id
  * @return int the value of the highest sort of the user_course_category
  */
 function api_max_sort_value($user_course_category, $user_id)
@@ -4679,6 +4686,8 @@ 
  * @param the dest folder
  * @param an array of excluded file_name (without extension)
  * @param copied_files the returned array of copied files
+ * @param string $source
+ * @param string $dest
  */
 function copyr($source, $dest, $exclude = array(), $copied_files = array()) {
     if (empty($dest)) { return false; }
@@ -4718,6 +4727,11 @@ 
 }
 
 // TODO: Using DIRECTORY_SEPARATOR is not recommended, this is an obsolete approach. Documentation header to be added here.
+/**
+ * @param string $pathname
+ * @param string $base_path_document
+ * @param integer $session_id
+ */
 function copy_folder_course_session(
     $pathname,
     $base_path_document,
@@ -4803,6 +4817,9 @@ 
 }
 
 // TODO: chmodr() is a better name. Some corrections are needed. Documentation header to be added here.
+/**
+ * @param string $path
+ */
 function api_chmod_R($path, $filemode) {
     if (!is_dir($path)) {
         return chmod($path, $filemode);
@@ -4885,7 +4902,7 @@ 
  *   version = VERSION
  * @endverbatim
  * </code>
- * @param $filename
+ * @param string $filename
  *   The file we are parsing. Accepts file with relative or absolute path.
  * @return
  *   The info array.
@@ -4977,7 +4994,7 @@ 
 /**
  * Checks whether status given in parameter exists in the platform
  * @param mixed the status (can be either int either string)
- * @return true if the status exists, else returns false
+ * @return boolean if the status exists, else returns false
  */
 function api_status_exists($status_asked) {
     global $_status_list;
@@ -4999,7 +5016,7 @@ 
 
 /**
  * Gets the status langvars list
- * @return array the list of status with their translations
+ * @return string[] the list of status with their translations
  */
 function api_get_status_langvars() {
     return array(
@@ -5075,6 +5092,7 @@ 
  * @param string    The sub-variable if any (in most cases, this will remain null)
  * @param string    The category if any (in most cases, this will remain null)
  * @param int       The access_url for which this parameter is valid
+ * @param string $cat
  */
 function api_set_setting($var, $value, $subvar = null, $cat = null, $access_url = 1)
 {
@@ -5172,6 +5190,8 @@ 
  * @param string    Value
  * @param int       Access URL. Optional. Defaults to 1
  * @param array     Optional array of filters on field type
+ * @param string $category
+ * @param string $value
  */
 function api_set_settings_category($category, $value = null, $access_url = 1, $fieldtype = array())
 {
@@ -5418,6 +5438,10 @@ 
  * @param string    The subkey text
  * @param int       The access_url for which this parameter is valid
  * @param int       The changeability of this setting for non-master urls
+ * @param string $val
+ * @param string $var
+ * @param string $sk
+ * @param string $c
  * @return boolean  true on success, false on failure
  */
 function api_add_setting($val, $var, $sk = null, $type = 'textfield', $c = null, $title = '', $com = '', $sc = null, $skt = null, $a = 1, $v = 0) {
@@ -5683,6 +5707,7 @@ 
  * @param String the tool of the element
  * @param int the element id in database
  * @param int the session_id to compare with element session id
+ * @param string $tool
  * @return boolean true if the element is in the session, false else
  */
 function api_is_element_in_the_session($tool, $element_id, $session_id = null) {
@@ -5728,8 +5753,6 @@ 
  * Replaces "forbidden" characters in a filename string.
  *
  * @param string $filename
- * @param int $length
- * @param bool $file_name
  *
  * @return string
  */
@@ -5965,6 +5988,7 @@ 
  * @link http://php.net/manual/en/function.getimagesize.php
  * @link http://www.dokeos.com/forum/viewtopic.php?t=12345
  * @link http://www.dokeos.com/forum/viewtopic.php?t=16355
+ * @return integer
  */
 function api_getimagesize($path) {
     $image = new Image($path);
@@ -6125,6 +6149,7 @@ 
  * with his user id and the access_url_id=1
  *
  * @author Julio Montoya
+ * @param integer $user_id
  */
 function api_is_global_platform_admin($user_id = null)
 {
@@ -6186,7 +6211,7 @@ 
  * @param int $admin_id_to_check
  * @param int  $my_user_id
  * @param bool $allow_session_admin
- * @return bool
+ * @return boolean|null
  */
 function api_protect_super_admin($admin_id_to_check, $my_user_id = null, $allow_session_admin = false)
 {
@@ -6428,6 +6453,7 @@ 
 
 /**
  * Returns the <link> HTML tag
+ * @param string $file
  */
 function api_get_css($file, $media = 'screen') {
     return '<link href="'.$file.'" rel="stylesheet" media="'.$media.'" type="text/css" />'."\n";
@@ -6555,7 +6581,8 @@ 
  * This function relies on api_get_course_info()
  * @param   string  The course code - optional (takes it from session if not given)
  * @param   int     The session id  - optional (takes it from session if not given)
- * @return  mixed   The URL of the course or null if something does not work
+ * @param integer $session_id
+ * @return  string|null   The URL of the course or null if something does not work
  * @author  Julio Montoya <gugli100@gmail.com>
  */
 function api_get_course_url($course_code = null, $session_id = null)
@@ -6670,7 +6697,7 @@ 
  * @param int       LINK_EXERCISE, LINK_STUDENTPUBLICATION, LINK_LEARNPATH LINK_FORUM_THREAD, LINK_ATTENDANCE
  * see gradebook/lib/be/linkfactory
  * @param string    course code
- * @return boolean
+ * @return false|null
  */
 function api_block_course_item_locked_by_gradebook($item_id, $link_type, $course_code = null) {
     if (api_is_platform_admin()) {
@@ -6711,7 +6738,7 @@ 
 /**
  * Returns an array of global configuration settings which should be ignored
  * when printing the configuration settings screens
- * @return array Array of strings, each identifying one of the excluded settings
+ * @return string[] Array of strings, each identifying one of the excluded settings
  */
 function api_get_locked_settings() {
     return array(
@@ -6754,7 +6781,7 @@ 
  * false if he isn't. If the user ID is given and is an integer, then the same
  * ID is simply returned
  * @param  integer User ID
- * @return mixed Integer User ID is logged in, or false otherwise
+ * @return boolean Integer User ID is logged in, or false otherwise
  */
 function api_user_is_login($user_id = null) {
     $user_id = empty($user_id) ? api_get_user_id() : intval($user_id);
@@ -6789,6 +6816,7 @@ 
  * Checks whether an IP is included inside an IP range
  * @param string IP address
  * @param string IP range
+ * @param string $ip
  * @return bool True if IP is in the range, false otherwise
  * @author claudiu at cnixs dot com  on http://www.php.net/manual/fr/ref.network.php#55230
  * @author Yannick Warnier for improvements and managment of multiple ranges
@@ -7172,6 +7200,7 @@ 
 /**
  * Tries to set memory limit, if authorized and new limit is higher than current
  * @param string New memory limit
+ * @param string $mem
  * @return bool True on success, false on failure or current is higher than suggested
  * @assert (null) === false
  * @assert (-1) === false
@@ -7228,7 +7257,6 @@ 
 
 /**
  * Finds all the information about a user from username instead of user id
- * @param string $username
  *
  * @return array $user_info user_id, lastname, firstname, username, email, ...
  * @author Yannick Warnier <yannick.warnier@beeznest.com>
@@ -7250,7 +7278,6 @@ 
 
 /**
  *
- * @param string $inputId the jquery id example: #password
  *
  * @return string
  */
@@ -7375,6 +7402,7 @@ 
 /**
  * Remove tags from HTML anf return the $in_number_char first non-HTML char
  * Postfix the text with "..." if it has been truncated.
+ * @param integer $in_number_char
  * @return string
  * @author hubert borderiou
  */
@@ -7419,7 +7447,7 @@ 
 /**
  * @param string $tool
  * @param string $setting
- * @param mixed $defaultValue
+ * @param integer $defaultValue
  * @return string
  */
 function api_get_default_tool_setting($tool, $setting, $defaultValue)
@@ -7544,7 +7572,7 @@ 
 }
 
 /**
- * @return true if course_code for direct course access after login is set
+ * @return boolean if course_code for direct course access after login is set
  */
 function exist_firstpage_parameter()
 {
@@ -7836,7 +7864,7 @@ 
  * @param array     data file (path and filename)
  * @param array     data to attach a file (optional)
  * @param bool      True for attaching a embedded file inside content html (optional)
- * @return          returns true if mail was sent
+ * @return          integer true if mail was sent
  * @see             class.phpmailer.php
  */
 function api_mail_html(

main/inc/lib/app_view.php

Doc Comments +3 added lines

@@ -18,6 +18,7 @@ 
     /**
      * Constructor, init tool path for rendering
      * @param string  tool name (optional)
+     * @param string $template_path
      */
     public function __construct($toolname = '', $template_path=null)
     {
@@ -50,6 +51,7 @@ 
     /**
      * Set layout view sent from a controller
      * @param string layout view
+     * @param string $layout
      */
     public function set_layout( $layout )
     {
@@ -59,6 +61,7 @@ 
     /**
      * Set template view sent from a controller
      * @param string template view
+     * @param string $template
      */
     public function set_template($template)
     {

main/inc/lib/banner.lib.php

Doc Comments +6 added lines

@@ -147,6 +147,9 @@ 
     return $customTabs;
 }
 
+/**
+ * @param string $theme
+ */
 function return_logo($theme)
 {
     $_course = api_get_course_info();
@@ -497,6 +500,9 @@ 
     return $menu;
 }
 
+/**
+ * @param string $nameTools
+ */
 function return_breadcrumb($interbreadcrumb, $language_file, $nameTools)
 {
     $session_id = api_get_session_id();

main/inc/lib/blog.lib.php

Doc Comments +7 added lines, -11 removed lines

@@ -96,9 +96,7 @@ 
 	/**
 	 * Creates a new blog in the given course
 	 * @author Toon Keppens
-	 * @param Integer $course_id Id
 	 * @param String $title
-	 * @param Text $description
 	 */
 	public static function create_blog($title, $subtitle)
 	{
@@ -186,9 +184,7 @@ 
 	/**
 	 * Update title and subtitle of a blog in the given course
 	 * @author Toon Keppens
-	 * @param Integer $course_id Id
 	 * @param String $title
-	 * @param Text $description
 	 */
 	public static function edit_blog($blog_id, $title, $subtitle)
 	{
@@ -714,7 +710,6 @@ 
 	/**
 	 * Deletes an assigned task from a blog
 	 * @param Integer $blog_id
-	 * @param Integer $assignment_id
 	 */
 	public static function delete_assigned_task($blog_id, $task_id, $user_id)
 	{
@@ -1126,9 +1121,7 @@ 
 	 *
 	 * @param String $type
 	 * @param Integer $blog_id
-	 * @param Integer $item_id
-	 *
-	 *@return String
+	 * @param integer $post_id
 	 */
 	public static function display_rating_form ($type, $blog_id, $post_id, $comment_id = NULL)
 	{
@@ -2113,7 +2106,7 @@ 
 	 *
 	 * @param Integer $blog_id
 	 *
-	 * @return Html Form with sortable table with users to unsubcribe from a blog.
+	 * @return false|null Form with sortable table with users to unsubcribe from a blog.
 	 */
 	public static function display_form_user_unsubscribe ($blog_id)
 	{
@@ -2234,6 +2227,7 @@ 
 	 * @author Toon Keppens
 	 *
 	 * @param Integer $blog_id
+	 * @param integer $post_id
 	 */
 	public static function display_new_comment_form($blog_id, $post_id, $title)
 	{
@@ -2282,10 +2276,8 @@ 
 	 * @author Patrick Cool
 	 * @author Toon Keppens
 	 *
-	 * @param Array $blogitems an array containing all the blog items for the given month
 	 * @param Integer $month: the integer value of the month we are viewing
 	 * @param Integer $year: the 4-digit year indication e.g. 2005
-	 * @param String $monthName: the language variable for the mont name
 	 *
 	 * @return html code
 	*/
@@ -2579,6 +2571,7 @@ 
  * @param the blog's id
  * @param the post's id
  * @param the comment's id
+ * @param integer $blog_id
  * @return array with the post info according the parameters
  * @author Julio Montoya Dokeos
  * @version avril 2008, dokeos 1.8.5
@@ -2620,6 +2613,9 @@ 
  * @param the blog's id
  * @param the post's id
  * @param the comment's id
+ * @param integer $blog_id
+ * @param integer $post_id
+ * @param integer $comment_id
  * @author Julio Montoya Dokeos
  * @version avril 2008, dokeos 1.8.5
  */

main/inc/lib/browser/Browser.php

Doc Comments +2 added lines, -2 removed lines

@@ -158,7 +158,7 @@ 
 
     /**
      * Set the name of the browser
-     * @param $browser string The name of the Browser
+     * @param string $browser string The name of the Browser
      */
     public function setBrowser($browser)
     {
@@ -266,7 +266,7 @@ 
 
     /**
      * Set the browser to be from AOL
-     * @param $isAol
+     * @param boolean $isAol
      */
     public function setAol($isAol)
     {

main/inc/lib/career.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {
@@ -96,7 +96,7 @@ 
      * @todo the form should be auto generated
      * @param   string  $url
      * @param   string  $action add, edit
-     * @return  obj     form validator obj
+     * @return  FormValidator     form validator obj
      */
     public function return_form($url, $action)
     {