chamilo / chamilo-lms

main/inc/lib/social.lib.php

Doc Comments +14 added lines, -4 removed lines

@@ -63,6 +63,8 @@ 
      * @param int user id
      * @param int user friend id
      * @param string
+     * @param integer $user_id
+     * @param integer $user_friend
      * @author isaac flores paz
      */
     public static function get_relation_between_contacts($user_id, $user_friend)
@@ -94,6 +96,8 @@ 
      * @param int group id
      * @param string name to search
      * @param bool true will load firstname, lastname, and image name
+     * @param integer $user_id
+     * @param integer $id_group
      * @return array
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code, function renamed, $load_extra_info option added
      * @author isaac flores paz
@@ -170,6 +174,9 @@ 
      * @param int user friend id
      * @param string title of the message
      * @param string content of the message
+     * @param integer $user_id
+     * @param string $message_title
+     * @param string $message_content
      * @return boolean
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
@@ -241,6 +248,7 @@ 
      * Get number messages of the inbox
      * @author isaac flores paz
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @return int
      */
     public static function get_message_number_invitation_by_user_id($user_receiver_id)
@@ -283,6 +291,7 @@ 
      * Get invitation list sent by user
      * @author Julio Montoya <gugli100@gmail.com>
      * @param int user id
+     * @param integer $user_id
      * @return array()
      */
     public static function get_list_invitation_sent_by_user_id($user_id)
@@ -325,6 +334,7 @@ 
      * Denies invitation
      * @param int user sender id
      * @param int user receiver id
+     * @param integer $user_receiver_id
      * @author isaac flores paz
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      */
@@ -360,7 +370,7 @@ 
      * @author Isaac Flores Paz <isaac.flores.paz@gmail.com>
      * @author Julio Montoya <gugli100@gmail.com> Cleaning code
      * @param void
-     * @return string message invitation
+     * @return false|null message invitation
      */
     public static function send_invitation_friend_user($userfriend_id, $subject_message = '', $content_message = '')
     {
@@ -1229,7 +1239,7 @@ 
      * @param string $messageContent of the message
      * @param int $messageId id parent
      * @param string $messageStatus status type of message
-     * @return boolean
+     * @return false|string
      * @author Yannick Warnier
      */
     public static function sendWallMessage($userId, $friendId, $messageContent, $messageId = 0, $messageStatus = '')
@@ -1318,7 +1328,7 @@ 
      * Gets all messages from someone's wall (within specific limits)
      * @param int $userId id of wall shown
      * @param string $messageStatus status wall message
-     * @param int|string $parentId id message (Post main)
+     * @param integer|null $parentId id message (Post main)
      * @param date $start Date from which we want to show the messages, in UTC time
      * @param int $limit Limit for the number of parent messages we want to show
      * @param int $offset Wall message query offset
@@ -1647,7 +1657,7 @@ 
     /**
     * Delete messages delete logic
     * @param int $id id message to delete.
-    * @return bool status query
+    * @return Statement|null status query
     */
     public static function deleteMessage($id)
     {

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($visibility_options, $hide_navigation = true, $per_page = 20, $sort_data = true, $grid_class = array())

main/inc/lib/specific_fields_manager.lib.php

Doc Comments +3 added lines, -1 removed lines

@@ -100,7 +100,7 @@ 
 
 /**
  * @param array $conditions a list of condition (exemple : status=>STUDENT)
- * @param array $order_by a list of fields on which sort
+ * @param string[] $order_by a list of fields on which sort
  * @return array An array with all users of the platform.
  */
 function get_specific_field_values_list(
@@ -235,6 +235,7 @@ 
  * @param   string  Course code
  * @param   string  Tool ID
  * @param   int     Internal ID used in specific tool table
+ * @param string $tool_id
  */
 function delete_all_values_for_item($course_id, $tool_id, $ref_id) {
   $table_sf_values = Database :: get_main_table(TABLE_MAIN_SPECIFIC_FIELD_VALUES);
@@ -248,6 +249,7 @@ 
  * Defaults to the first letter of the name, otherwise iterate through available
  * letters
  * @param   string  Name
+ * @param string $name
  * @return  string  One-letter code, upper-case
  */
 function get_specific_field_code_from_name($name) {

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