chamilo / chamilo-lms

main/inc/lib/sub_language.class.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,6 +18,7 @@ 
      * Get all files of lang folder (forum.inc.php,gradebook.inc.php,notebook.inc.php)
      * @param String The lang path folder  (/var/www/my_lms/main/lang/spanish)
      * @param bool true if we only want the "subname" trad4all instead of  trad4all.inc.php
+     * @param string $path
      *
      * @return Array All file of lang folder
      */
@@ -68,6 +69,7 @@ 
     /**
      * Get all information of language
      * @param Integer The parent id(Language father id)
+     * @param integer $parent_id
      * @return Array All information about language
      */
     public static function get_all_information_of_language($parent_id)
@@ -86,6 +88,7 @@ 
     /**
      * Get all information of chamilo file
      * @param String The chamilo path file (/var/www/chamilo/main/lang/spanish/gradebook.inc.php)
+     * @param string $system_path_file
      * @patam Bool Whether we want to remove the '$' prefix in the results or not
      * @return Array Contains all information of chamilo file
      */
@@ -345,7 +348,7 @@ 
     /**
      * Make available the language
      * @param Integer The language id
-     * @return void
+     * @return boolean
      */
     public static function make_available_language($language_id)
     {

main/inc/lib/system/web/request.class.php

Doc Comments +4 added lines

@@ -31,6 +31,10 @@
         return $method == 'GET';
     }
 
+    /**
+     * @param string $key
+     * @param string $default
+     */
     public static function post($key, $default = null)
     {
         return isset($_POST[$key]) ? $_POST[$key] : $default;

main/inc/lib/table_sort.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
 	 * @param string $direction The direction to sort (SORT_ASC (default) orSORT_DESC)
 	 * @param array $column_show The columns that we will show in the table i.e: $column_show = array('1','0','1') we will show the 1st and the 3th column.
 	 * @param array $column_order Changes how the columns will be sorted ie. $column_order = array('0','3','2','3') The column [1] will be sorted like the column [3]
-	 * @param constant $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
+	 * @param integer $type How should data be sorted (SORT_REGULAR, SORT_NUMERIC, SORT_STRING, SORT_DATE, SORT_IMAGE)
 	 * @return array The sorted dataset
 	 * @author bart.mollet@hogent.be
 	 */

main/inc/lib/template.lib.php

Doc Comments +2 added lines

@@ -330,6 +330,7 @@ 
     /**
      * Sets the footer visibility
      * @param bool true if we show the footer
+     * @param boolean $status
      */
     public function set_footer($status)
     {
@@ -370,6 +371,7 @@ 
     /**
      * Sets the header visibility
      * @param bool true if we show the header
+     * @param boolean $status
      */
     public function set_header($status)
     {

main/inc/lib/text.lib.php

Doc Comments +10 added lines, -5 removed lines

@@ -52,6 +52,7 @@ 
  * Converts the text of a html-document to a given encoding, the meta-tag is changed accordingly.
  * @param string $string                The input full-html document.
  * @param string                        The new encoding value to be set.
+ * @param string $encoding
  */
 function api_set_encoding_html(&$string, $encoding) {
     $old_encoding = api_detect_encoding_html($string);
@@ -74,7 +75,7 @@ 
  * Returns the title of a html document.
  * @param string $string                The contents of the input document.
  * @param string $input_encoding        The encoding of the input document. If the value is not set, it is detected.
- * @param string $$output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
+ * @param string $output_encoding      The encoding of the retrieved title. If the value is not set, the system encoding is assumend.
  * @return string                       The retrieved title, html-entities and extra-whitespace between the words are cleaned.
  */
 function api_get_title_html(&$string, $output_encoding = null, $input_encoding = null) {
@@ -433,7 +434,7 @@ 
  * @since wordpress  2.8.1
  * @access private
  *
- * @param string|array $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
+ * @param string[] $search The value being searched for, otherwise known as the needle. An array may be used to designate multiple needles.
  * @param string $subject The string being searched and replaced on, otherwise known as the haystack.
  * @return string The string with the replaced svalues.
  */
@@ -628,6 +629,7 @@ 
  * @param string    The text to "cut"
  * @param int       Count of chars
  * @param bool      Whether to embed in a <span title="...">...</span>
+ * @param integer $maxchar
  * @return string
  * */
 function cut($text, $maxchar, $embed = false) {
@@ -645,7 +647,7 @@ 
  *
  * @param mixed     Number to convert
  * @param int       Decimal points 0=never, 1=if needed, 2=always
- * @return mixed    An integer or a float depends on the parameter
+ * @return string|null    An integer or a float depends on the parameter
  */
 function float_format($number, $flag = 1) {
     if (is_numeric($number)) {
@@ -689,7 +691,7 @@ 
 /**
  * Gets the week from a day
  * @param   string   Date in UTC (2010-01-01 12:12:12)
- * @return  int      Returns an integer with the week number of the year
+ * @return  string      Returns an integer with the week number of the year
  */
 function get_week_from_day($date) {
     if (!empty($date)) {
@@ -739,6 +741,9 @@ 
 	return $output.$end;
 }
 
+/**
+ * @param string $glue
+ */
 function implode_with_key($glue, $array) {
     if (!empty($array)) {
         $string = '';
@@ -817,7 +822,7 @@ 
 /**
  * @param string $string
  * @param bool $capitalizeFirstCharacter
- * @return mixed
+ * @return string
  */
 function underScoreToCamelCase($string, $capitalizeFirstCharacter = true)
 {

main/inc/lib/timeline.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,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)
     {

main/inc/lib/tracking.lib.php

Doc Comments +13 added lines, -7 removed lines

@@ -1287,6 +1287,8 @@ 
      * @param   string type of time filter: 'last_week' or 'custom'
      * @param   string  start date date('Y-m-d H:i:s')
      * @param   string  end date date('Y-m-d H:i:s')
+     * @param string $start_date
+     * @param string $end_date
      * @return timestamp $nb_seconds
      */
     public static function get_time_spent_on_the_platform(
@@ -1390,7 +1392,7 @@ 
      * Get first connection date for a student
      * @param    int $student_id
      *
-     * @return    string|bool Date format long without day or false if there are no connections
+     * @return    string|false Date format long without day or false if there are no connections
      */
     public static function get_first_connection_date($student_id)
     {
@@ -1420,7 +1422,7 @@ 
      * @param int $student_id
      * @param bool $warning_message Show a warning message (optional)
      * @param bool $return_timestamp True for returning results in timestamp (optional)
-     * @return string|int|bool Date format long without day, false if there are no connections or
+     * @return string Date format long without day, false if there are no connections or
      * timestamp if parameter $return_timestamp is true
      */
     public static function get_last_connection_date($student_id, $warning_message = false, $return_timestamp = false)
@@ -2667,6 +2669,9 @@ 
      * @param     array         Limit average to listed lp ids
      * @param     int            Session id (optional), if param $session_id is
      * null(default) it'll return results including sessions, 0 = session is not filtered
+     * @param integer $student_id
+     * @param string $course_code
+     * @param integer $session_id
      * @return     int         Total time
      */
     public static function get_time_spent_in_lp($student_id, $course_code, $lp_ids = array(), $session_id = null)
@@ -2733,6 +2738,8 @@ 
      * @param     int|array    Student id(s)
      * @param     string         Course code
      * @param     int         Learning path id
+     * @param integer $student_id
+     * @param string $course_code
      * @return     int         Total time
      */
     public static function get_last_connection_time_in_lp($student_id, $course_code, $lp_id, $session_id = 0)
@@ -5400,7 +5407,7 @@ 
 
     /**
     * @param FormValidator $form
-    * @return mixed
+    * @return FormValidator
     */
     public static function setUserSearchForm($form)
     {
@@ -5439,7 +5446,6 @@ 
      * @param   int $sessionId  The session ID (session.id)
      * @param   int $courseId   The course ID (course.id)
      * @param   int $exerciseId The quiz ID (c_quiz.id)
-     * @param   int $answer     The answer status (0 = incorrect, 1 = correct, 2 = both)
      * @param   array   $options    An array of options you can pass to the query (limit, where and order)
      * @return array An array with the data of exercise(s) progress
      */
@@ -6876,7 +6882,7 @@ 
      * @param int $user_id
      * @param int $course_id
      * @param int $session_id
-     * @return array
+     * @return string[]
      */
     public function display_login_tracking_info($view, $user_id, $course_id, $session_id = 0)
     {
@@ -6922,9 +6928,9 @@ 
     /**
      * Displays the exercise results for a specific user in a specific course.
      * @param   string $view
-     * @param   int $user_id    User ID
+     * @param   int $userId    User ID
      * @param   string  $courseCode Course code
-     * @return array
+     * @return string[]
      * @todo remove globals
      */
     public function display_exercise_tracking_info($view, $userId, $courseCode)

main/inc/lib/urlmanager.lib.php

Doc Comments +16 added lines, -14 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|null 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|null if success
     */
     public static function update($url_id, $url, $description, $active)
     {
@@ -67,7 +67,7 @@ 
     * @author Julio Montoya
     * @param int $id url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete($id)
     {
@@ -366,7 +366,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)
     {
@@ -384,7 +384,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)
     {
@@ -405,7 +405,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)
     {
@@ -424,7 +424,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)
     {
@@ -545,6 +545,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)
@@ -575,7 +577,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)
     {
@@ -592,7 +594,7 @@ 
     /**
      * @param int $userGroupId
      * @param int $urlId
-     * @return int
+     * @return string
      */
     public static function addUserGroupToUrl($userGroupId, $urlId)
     {
@@ -692,7 +694,7 @@ 
      * @param int $courseId
      * @param int $url_id
      *
-     * @return resource
+     * @return boolean
      */
     public static function add_course_to_url($courseId, $url_id = 1)
     {
@@ -763,7 +765,7 @@ 
     * @param  int  $courseId
     * @param  int  $urlId
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_course($courseId, $urlId)
     {
@@ -781,7 +783,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
     {
@@ -800,7 +802,7 @@ 
      * @param  int $userGroupId
      * @param  int $urlId
      *
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
     {
@@ -819,7 +821,7 @@ 
     * @param  char  course code
     * @param  int url id
      *
-    * @return boolean true if success
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
     * */
     public static function delete_url_rel_session($session_id, $url_id)
     {

main/inc/lib/usergroup.lib.php

Doc Comments +12 added lines, -6 removed lines

@@ -1013,7 +1013,7 @@ 
      * @param int    $groupId
      * @param string $picture
      *
-     * @return bool|string
+     * @return false|string
      */
     public function manageFileUpload($groupId, $picture)
     {
@@ -1155,7 +1155,7 @@ 
     }
 
     /**
-     * @return mixed
+     * @return integer
      */
     public function getGroupType()
     {
@@ -1359,6 +1359,8 @@ 
      * @param string height
      * @param string picture size it can be small_,  medium_  or  big_
      * @param string style css
+     * @param integer $height
+     * @param integer $size_picture
      * @return array with the file and the style of an image i.e $array['file'] $array['style']
      */
     public function get_picture_group($id, $picture_file, $height, $size_picture = GROUP_IMAGE_SIZE_MEDIUM , $style = '')
@@ -1420,7 +1422,7 @@ 
      * @param	string	Type of path to return (can be 'none', 'system', 'rel', 'web')
      * @param	bool	Whether we want to have the directory name returned 'as if' there was a file or not (in the case we want to know which directory to create - otherwise no file means no split subdir)
      * @param	bool	If we want that the function returns the /main/img/unknown.jpg image set it at true
-     * @return	array 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
+     * @return	integer 	Array of 2 elements: 'dir' and 'file' which contain the dir and file as the name implies if image does not exist it will return the unknow image if anonymous parameter is true if not it returns an empty er's
      */
     public function get_group_picture_path_by_id($id, $type = 'none', $preview = false, $anonymous = false)
     {
@@ -1470,7 +1472,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getAllowedPictureExtensions()
     {
@@ -1660,7 +1662,7 @@ 
      * @author Julio Montoya
      * @param  int  $user_id
      * @param  int $group_id
-     * @return boolean true if success
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
      * */
     public function delete_user_rel_group($user_id, $group_id)
     {
@@ -1872,6 +1874,8 @@ 
      * @param int from value
      * @param int limit
      * @param array image configuration, i.e array('height'=>'20px', 'size'=> '20px')
+     * @param integer $from
+     * @param integer $limit
      * @return array list of users in a group
      */
     public function get_users_by_group(
@@ -1970,6 +1974,8 @@ 
      * Shows the left column of the group page
      * @param int group id
      * @param int user id
+     * @param integer $group_id
+     * @param integer $user_id
      *
      */
     public function show_group_column_information($group_id, $user_id, $show = '')
@@ -2323,7 +2329,7 @@ 
      * @param int $group_id
      * @param int $parent_group_id if 0, we delete the parent_group association
      * @param int $relation_type
-     * @return resource
+     * @return Doctrine\DBAL\Driver\Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {