chamilo / chamilo-lms

main/inc/lib/extra_field.lib.php

Doc Comments +8 added lines, -9 removed lines

@@ -123,7 +123,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public static function getValidExtraFieldTypes()
     {
@@ -199,7 +199,7 @@ 
 
     /**
      * @param array $conditions
-     * @param null  $order_field_options_by
+     * @param string  $order_field_options_by
      *
      * @return array
      */
@@ -237,7 +237,7 @@ 
     /**
      * @param string $variable
      *
-     * @return array|bool
+     * @return integer
      */
     public function get_handler_field_info_by_field_variable($variable)
     {
@@ -319,7 +319,7 @@ 
     /**
      * @param string $handler
      *
-     * @return array
+     * @return string[]
      */
     public static function get_extra_fields_by_handler($handler)
     {
@@ -496,7 +496,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_field_types()
     {
@@ -506,7 +506,7 @@ 
     /**
      * @param int $id
      *
-     * @return null
+     * @return string|null
      */
     public function get_field_type_by_id($id)
     {
@@ -691,7 +691,6 @@ 
      * @param FormValidator $form
      * @param array $extraData
      * @param bool $admin_permissions
-     * @param int $user_id
      * @param array $extra
      * @param int $itemId
      * @param array $exclude variables of extra field to exclude
@@ -1592,7 +1591,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function getJqgridColumnNames()
     {
@@ -1832,7 +1831,7 @@ 
     }
 
     /**
-     * @param array $columns
+     * @param string[] $columns
      * @param array  $column_model
      * @param array  $extraFields
      * @return array

main/inc/lib/extra_field_value.lib.php

Doc Comments +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
     }
 
     /**
-     * @return ExtraField
+     * @return string
      */
     public function getExtraField()
     {
@@ -72,7 +72,7 @@ 
      * This function is used with $extraField->addElements()
      * @param array $params array for the insertion into the *_field_values table
      *
-     * @return mixed false on empty params, void otherwise
+     * @return false|null false on empty params, void otherwise
      * @assert (array()) === false
      */
     public function saveFieldValues($params)
@@ -500,7 +500,7 @@ 
      * @param int $item_id Item ID (It could be a session_id, course_id or user_id)
      * @param int $field_id Field ID (the ID from the *_field table)
      * @param bool $transform Whether to transform the result to a human readable strings
-     * @return mixed A structured array with the field_id and field_value, or false on error
+     * @return string A structured array with the field_id and field_value, or false on error
      * @assert (-1,-1) === false
      */
     public function get_values_by_handler_and_field_id($item_id, $field_id, $transform = false)
@@ -593,7 +593,7 @@ 
      * @param int $item_id Item ID from the original table
      * @param string $field_variable The name of the field we are looking for
      * @param bool $transform
-     * @param bool $allVisibility
+     * @param bool $visibility
      *
      * @return mixed Array of results, or false on error or not found
      * @assert (-1,'') === false

main/inc/lib/formvalidator/Element/DateRangePicker.php

Doc Comments +1 added lines

@@ -145,6 +145,7 @@
 
     /**
     * @param array $dates result of parseDateRange()
+    * @param string $format
     *
     * @return bool
     */

main/inc/lib/formvalidator/Rule/HTML.php

Doc Comments +1 added lines, -2 removed lines

@@ -25,8 +25,7 @@
      * Get allowed tags
      * @param int $mode NO_HTML, STUDENT_HTML, TEACHER_HTML,
      * STUDENT_HTML_FULLPAGE or TEACHER_HTML_FULLPAGE
-     * @param boolean $fullpage If true, the allowed tags for full-page editing
-     * are returned.
+     * @return string
      */
     static function get_allowed_tags($mode)
     {

main/inc/lib/formvalidator/Rule/MaxFileSize.php

Doc Comments -1 removed lines

@@ -9,7 +9,6 @@
 {
 	/**
 	 * @param $value array     Uploaded file info (from $_FILES)
-	 * @param null $options
 	 * @return bool
 	 */
 	public function validate($elementValue, $maxSize)

main/inc/lib/formvalidator/Rule/MobilePhoneNumber.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
      *
      * @param string Mobile phone number to be validated
      * @param string Not using it. Just to respect the declaration
-     * @return boolean Returns true if valid, false otherwise.
+     * @return integer Returns true if valid, false otherwise.
      */
     function validate($mobilePhoneNumber, $options = null)
     {

main/inc/lib/getid3/getid3.php

Doc Comments +22 added lines

@@ -456,6 +456,10 @@ 
 
 
     // Add warning(s) to $this->warnings[]
+
+    /**
+     * @param string $message
+     */
     public function warning($message) {
 
         if (is_array($message)) {
@@ -482,6 +486,11 @@ 
 
 
     // Convert string between charsets -- iconv() wrapper
+
+    /**
+     * @param string $out_charset
+     * @param string $string
+     */
     public function iconv($in_charset, $out_charset, $string, $drop01 = false) {
 
         if ($drop01 && ($string === "\x00" || $string === "\x01")) {
@@ -509,6 +518,9 @@ 
 
 
 
+    /**
+     * @param string $name
+     */
     public function include_module($name) {
 
         if (!file_exists($this->include_path.'module.'.$name.'.php')) {
@@ -1342,6 +1354,10 @@ 
 
 
     // Convert Big Endian byte string to int - max 32 bits
+
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Int($byte_word, $signed = false) {
 
         $int_value = 0;
@@ -1391,6 +1407,9 @@ 
 
 
 
+    /**
+     * @param string $byte_word
+     */
     public static function BigEndian2Float($byte_word) {
 
 		// ANSI/IEEE Standard 754-1985, Standard for Binary Floating Point Arithmetic
@@ -1478,6 +1497,9 @@ 
 
 
 
+	/**
+	 * @param string $binary_numerator
+	 */
 	public static function DecimalBinary2Float($binary_numerator) {
 		$numerator   = bindec($binary_numerator);
 		$denominator = bindec('1'.str_repeat('0', strlen($binary_numerator)));

main/inc/lib/getid3/module.audio-video.flv.php

Doc Comments +6 added lines

@@ -276,6 +276,9 @@ 
 	public $pos;
 
 
+	/**
+	 * @param string $bytes
+	 */
 	public function AMFStream($bytes) {
 
 		$this->bytes = $bytes;
@@ -389,6 +392,9 @@ 
 {
 	public $stream;
 
+	/**
+	 * @param AMFStream $stream
+	 */
 	public function __construct($stream) {
 
 		$this->stream = $stream;

main/inc/lib/glossary.lib.php

Doc Comments +6 added lines, -1 removed lines

@@ -86,7 +86,7 @@ 
      * This functions stores the glossary in the database
      *
      * @param array    Array of title + description (glossary_title => $title, glossary_comment => $comment)
-     * @return mixed   Term id on success, false on failure
+     * @return false|string   Term id on success, false on failure
      * @author Christian Fasanando <christian.fasanando@dokeos.com>
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium
      * @version januari 2009, dokeos 1.8.6
@@ -443,6 +443,10 @@ 
      * @param integer Number of items to collect
      * @param string  Name of column on which to order
      * @param string  Whether to sort in ascending (ASC) or descending (DESC)
+     * @param integer $from
+     * @param integer $number_of_items
+     * @param integer $column
+     * @param string $direction
      * @return unknown
      *
      * @author Patrick Cool <patrick.cool@ugent.be>
@@ -520,6 +524,7 @@ 
      * @param integer $glossary_id
      * @param array   Parameters to use to affect links
      * @param array   The line of results from a query on the glossary table
+     * @param string $url_params
      * @return string HTML string for the action icons columns
      *
      * @author Patrick Cool <patrick.cool@ugent.be>, Ghent University, Belgium