chamilo / chamilo-lms

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

main/inc/lib/gradebook.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -160,7 +160,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 show_skill_form($gradebook_id, $url, $header = null)
     {

main/inc/lib/group_portal_manager.lib.php

Doc Comments +10 added lines, -6 removed lines

@@ -21,7 +21,7 @@ 
      * @param	int		$visibility is active or not
      * @param   string  $picture
      *
-     * @return boolean if success
+     * @return string|false if success
      */
     public static function add($name, $description, $url, $visibility, $picture = '')
     {
@@ -57,7 +57,7 @@ 
      * @param int $visibility
      * @param string $picture_uri
      * @param bool $allowMemberGroupToLeave
-     * @return bool if success
+     * @return Statement|null if success
      */
     public static function update($group_id, $name, $description, $url, $visibility, $picture_uri, $allowMemberGroupToLeave = null)
     {
@@ -87,7 +87,7 @@ 
      * Deletes a group
      * @author Julio Montoya
      * @param int $id
-     * @return boolean true if success
+     * @return Statement|null true if success
      * */
     public static function delete($id)
     {
@@ -175,7 +175,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 Statement|null
      **/
     public static function set_parent_group($group_id, $parent_group_id, $relation_type = 1)
     {
@@ -652,6 +652,7 @@ 
      * @author Julio Montoya
      * @param  int user_id
      * @param  int url_id
+     * @param integer $relation_type
      * @return boolean true if success
      **/
     public static function add_user_to_group($user_id, $group_id, $relation_type = GROUP_USER_PERMISSION_READER)
@@ -735,7 +736,7 @@ 
      * @author Julio Montoya
      * @param int $group_id
      * @param int $relation_type (optional)
-     * @return boolean true if success
+     * @return Statement|null true if success
      * */
     public static function delete_users($group_id, $relation_type = null)
     {
@@ -916,6 +917,7 @@ 
      * If an empty name is provided, then old user photos are deleted only, @see UserManager::delete_user_picture()
      * as the prefered way for deletion.
      * @param	string		$source_file The full system name of the image from which user photos will be created.
+     * @param integer $group_id
      * @return	string/bool	Returns the resulting file name of created images which usually should be stored in DB.
      * When deletion is recuested returns empty string. In case of internal error or negative validation returns FALSE.
      */
@@ -1074,7 +1076,9 @@ 
      *
      * @param  string file picture
      * @param  int size in pixels
-     * @return obj image object
+     * @param string|null $file
+     * @param integer $max_size_for_picture
+     * @return Image image object
      */
     public static function resize_picture($file, $max_size_for_picture)
     {

main/inc/lib/groupmanager.lib.php

Doc Comments +13 added lines, -10 removed lines

@@ -369,7 +369,7 @@ 
      * @author Christophe Gesche <christophe.gesche@claroline.net>
      * @author Hugues Peeters <hugues.peeters@claroline.net>
      * @author Bart Mollet
-     * @param  mixed  $groupIdList - group(s) to delete. It can be a single id
+     * @param  mixed  $group_ids - group(s) to delete. It can be a single id
      *                                (int) or a list of id (array).
      * @param string $course_code Default is current course
      * @return integer              - number of groups deleted.
@@ -573,7 +573,7 @@ 
      * @param bool      Whether self registration is allowed or not
      * @param bool      Whether self unregistration is allowed or not
      * @param int       $categoryId
-     * @return bool     TRUE if properties are successfully changed, false otherwise
+     * @return Statement|null     TRUE if properties are successfully changed, false otherwise
      */
     public static function set_group_properties(
         $group_id,
@@ -724,7 +724,7 @@ 
      * @param int $group_id The id of the group
      * @param string $course_code The course in which the group is (default =
      * current course)
-     * @return array The category
+     * @return integer The category
      */
     public static function get_category_from_group($group_id, $course_code = null)
     {
@@ -786,9 +786,9 @@ 
      * Create group category
      * @param string $title The title of the new category
      * @param string $description The description of the new category
-     * @param bool $self_registration_allowed
-     * @param bool $self_unregistration_allowed
-     * @param int $max_number_of_students
+     * @param integer $self_registration_allowed
+     * @param integer $self_unregistration_allowed
+     * @param int $maximum_number_of_students
      * @param int $groups_per_user
      */
     public static function create_category(
@@ -994,6 +994,8 @@ 
      * @param int $limit
      * @param bool $getCount
      * @param int $courseId
+     * @param string $column
+     * @param string $direction
      * @return array list of user id
      */
     public static function get_users(
@@ -1172,7 +1174,7 @@ 
      *         Hugues Peeters     <hugues.peeters@claroline.net> - original version
      * @author Roan Embrechts - virtual course support, code cleaning
      * @author Bart Mollet - code cleaning, use other GroupManager-functions
-     * @return void
+     * @return false|null
      */
     public static function fill_groups($group_ids)
     {
@@ -1625,7 +1627,7 @@ 
      * Unsubscribe user(s) from a specified group in current course
      * @param mixed $user_ids Can be an array with user-id's or a single user-id
      * @param int $group_id
-     * @return bool TRUE if successful
+     * @return boolean|null TRUE if successful
      */
     public static function unsubscribe_users($user_ids, $group_id)
     {
@@ -1644,7 +1646,7 @@ 
 
     /**
      * Unsubscribe all users from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @return bool TRUE if successful
      */
     public static function unsubscribe_all_users($group_ids)
@@ -1676,7 +1678,7 @@ 
 
     /**
      * Unsubscribe all tutors from one or more groups
-     * @param mixed $group_id Can be an array with group-id's or a single group-id
+     * @param mixed $group_ids Can be an array with group-id's or a single group-id
      * @see unsubscribe_all_users. This function is almost an exact copy of that function.
      * @return bool TRUE if successful
      * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
@@ -1861,6 +1863,7 @@ 
      *
      * @param $user_array_in list of users (must be sorted).
      * @param string $compare_field, the field to be compared
+     * @param string $compare_field
      */
     public static function filter_duplicates($user_array_in, $compare_field)
     {

main/inc/lib/hook/HookManagement.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
 
     /**
      * Return a list an associative array where keys are the active hook observer class name
-     * @param $eventName
+     * @param string $eventName
      *
      * @return array
      */

main/inc/lib/image.lib.php

Doc Comments +19 added lines

@@ -52,6 +52,9 @@ 
         }
     }
     
+    /**
+     * @param string|null $cropParameters
+     */
     public function crop($cropParameters) {
         $image_size = $this->get_image_size($this->image_wrapper->path);
         $src_width = $image_size['width'];
@@ -66,6 +69,9 @@ 
         return $image;
     }
 
+    /**
+     * @param string $convert_file_to
+     */
     public function send_image(
         $file = '',
         $compress = -1,
@@ -147,6 +153,9 @@ 
     public $image;
     public $filter = Imagick::FILTER_LANCZOS;
 
+    /**
+     * @param string $path
+     */
     public function __construct($path)
     {
           parent::__construct($path);
@@ -194,6 +203,10 @@ 
 	}
 
 	//@todo implement border logic case for Imagick
+
+	/**
+	 * @param integer $border
+	 */
 	public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
 	    if (!$this->image_validated) return false;
@@ -275,6 +288,9 @@ 
 {
     public $bg;
 
+    /**
+     * @param string $path
+     */
     function __construct($path) {
         parent::__construct($path);
     }
@@ -332,6 +348,9 @@ 
     	}
     }
 
+    /**
+     * @param integer $border
+     */
     public function resize($thumbw, $thumbh, $border, $specific_size = false)
     {
         if (!$this->image_validated) return false;

main/inc/lib/kses-0.2.2/kses_original.php

Doc Comments +9 added lines

@@ -408,6 +408,9 @@ 
 } # function kses_no_null
 
 
+/**
+ * @return string
+ */
 function kses_stripslashes($string)
 ###############################################################################
 # This function changes the character sequence  \"  to just  "
@@ -442,6 +445,9 @@ 
 } # function kses_array_lc
 
 
+/**
+ * @return string
+ */
 function kses_js_entities($string)
 ###############################################################################
 # This function removes the HTML JavaScript entities found in early versions of
@@ -506,6 +512,9 @@ 
 } # function kses_bad_protocol_once2
 
 
+/**
+ * @return string
+ */
 function kses_normalize_entities($string)
 ###############################################################################
 # This function normalizes HTML entities. It will convert "AT&T" to the correct