chamilo / chamilo-lms

main/inc/lib/statsUtils.lib.inc.php

Doc Comments +1 added lines

@@ -85,6 +85,7 @@
     /**
      * @author Sebastien Piraux <piraux_seb@hotmail.com>
      * @param sql : a sql query (as a string)
+     * @param integer $X
      * @desc Return many results of a query in a X column tab
      * in $resu[$i][0], $resu[$i][1],$resu[$i][2],...
      * this function is more 'standard' but use a little

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

main/inc/lib/VideoChat.php

Doc Comments +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
      * Create a video chat
      * @param int $fromUser The sender user
      * @param int $toUser The receiver user
-     * @return int The created video chat id. Otherwise return false
+     * @return false|string The created video chat id. Otherwise return false
      */
     public static function createRoom($fromUser, $toUser)
     {

main/inc/lib/zombie/zombie_report.class.php

Doc Comments +3 added lines

@@ -121,6 +121,9 @@
         return $form->isSubmitted() == false || $form->validate();
     }
 
+    /**
+     * @param string $format
+     */
     function get_ceiling($format = null)
     {
         $result = Request::get('ceiling');