chamilo / chamilo-lms

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

main/inc/lib/grade_model.lib.php

Doc Comments +3 added lines

@@ -248,6 +248,9 @@
 	    //event_system(LOG_CAREER_DELETE, LOG_CAREER_ID, $id, api_get_utc_datetime(), api_get_user_id());
     }
 
+    /**
+     * @param CatForm $form
+     */
     public function fill_grade_model_select_in_form(&$form, $name = 'gradebook_model_id', $default_value = null)
     {
         if (api_get_setting('gradebook_enable_grade_model') == 'false') {

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/icalcreator/iCalcreator.class.php

Doc Comments +25 added lines, -30 removed lines

@@ -137,7 +137,7 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.8 - 2008-10-21
  * @param string $value
- * @return void
+ * @return false|null
  */
   function setCalscale( $value ) {
     if( empty( $value )) return FALSE;
@@ -273,7 +273,7 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.8 - 2008-10-23
  * @param string $value
- * @return void
+ * @return boolean
  */
   function setVersion( $value ) {
     if( empty( $value )) return FALSE;
@@ -397,7 +397,7 @@ 
  * @since 2.5.1 - 2008-11-02
  * @param string $propName, optional
  * @param int @propix, optional, if specific property is wanted in case of multiply occurences
- * @param bool $inclParam=FALSE
+ * @param bool $inclParam
  * @return mixed
  */
   function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE ) {
@@ -448,9 +448,6 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.2.13 - 2007-11-04
- * @param mixed $args variable number of function arguments,
- *                    first argument is ALWAYS component name,
- *                    second ALWAYS component value!
  * @return bool
  */
   function setProperty () {
@@ -480,7 +477,7 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.10 - 2008-10-23
  * @param string $config
- * @return value
+ * @return string
  */
   function getConfig( $config ) {
     switch( strtoupper( $config )) {
@@ -701,7 +698,7 @@ 
  * @since 2.4.10 - 2008-08-05
  * @param mixed $arg1 ordno / component type / component uid
  * @param mixed $arg2 optional, ordno if arg1 = component type
- * @return void
+ * @return boolean
  */
   function deleteComponent( $arg1, $arg2=FALSE  ) {
     $argType = $index = null;
@@ -1060,7 +1057,7 @@ 
  * @param object $component calendar component
  * @param mixed $arg1 optional, ordno/component type/ component uid
  * @param mixed $arg2 optional, ordno if arg1 = component type
- * @return void
+ * @return boolean
  */
   function setComponent( $component, $arg1=FALSE, $arg2=FALSE  ) {
     if( '' >= $component->getConfig( 'language'))
@@ -2309,7 +2306,7 @@ 
  * @param int $min optional
  * @param int $sec optional
  * @param array $params optional
- * @return TRUE
+ * @return boolean
  */
   function setDtstamp( $year, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
     if( empty( $year ))
@@ -2792,7 +2789,7 @@ 
  * @param int $min optional
  * @param int $sec optional
  * @param array $params optional
- * @return boll
+ * @return boolean
  */
   function setLastModified( $year=FALSE, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
     if( empty( $year ))
@@ -3213,7 +3210,6 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.5.1 - 2008-11-07
- * @param float $relid
  * @param array $params, optional
  * @param index $index, optional
  * @return bool
@@ -3251,7 +3247,7 @@ 
  * @since 2.4.8 - 2008-11-04
  * @param string $value
  * @param array $params optional
- * @return void
+ * @return boolean
  */
   function setRepeat( $value, $params=FALSE ) {
     if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3374,7 +3370,7 @@ 
  * @param array $rruleset
  * @param array $params, optional
  * @param integer $index, optional
- * @return void
+ * @return boolean
  */
   function setRrule( $rruleset, $params=FALSE, $index=FALSE ) {
     if( empty( $rruleset )) if( $this->getConfig( 'allowEmpty' )) $rruleset = null; else return FALSE;
@@ -3800,7 +3796,7 @@ 
  * @since 2.4.8 - 2008-11-04
  * @param string $value
  * @param string $params optional
- * @return boll
+ * @return boolean
  */
   function setTzurl( $value, $params=FALSE ) {
     if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3929,7 +3925,7 @@ 
  * @param string $label
  * @param mixed $value
  * @param array $params optional
- * @return bool
+ * @return null|boolean
  */
   function setXprop( $label, $value, $params=FALSE ) {
     if( empty( $label )) return;
@@ -4096,7 +4092,7 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 0.9.22 - 2007-04-10
  * @param array $params  optional
- * @param array $ctrKeys optional
+ * @param string[] $ctrKeys optional
  * @return string
  */
   function _createParams( $params=array(), $ctrKeys=array() ) {
@@ -4138,7 +4134,6 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.16 - 2008-10-25
- * @param array $date, date to check
  * @param int $parno, no of date parts (i.e. year, month.. .)
  * @return array $params, property parameters
  */
@@ -4194,7 +4189,6 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.2.11 - 2007-11-03
  * @param array $startdate, optional
- * @param array $duration, optional
  * @return array duration
  */
   function _date2duration( $startdate=FALSE, $enddate=FALSE ) {
@@ -4228,7 +4222,7 @@ 
  * @since 2.4.8 - 2008-10-30
  * @param array  $datetime  datetime/(date)
  * @param string $tz        timezone
- * @return timestamp
+ * @return integer
  */
   function _date2timestamp( $datetime, $tz=null ) {
     $output = null;
@@ -4541,6 +4535,7 @@ 
  * @param int $hitVal optional, return value if found
  * @param int $elseVal optional, return value if not found
  * @param int $preSet optional, return value if already preset
+ * @param string $expkey
  * @return int
  */
   function _existRem( &$array, $expkey, $expval=FALSE, $hitVal=null, $elseVal=null, $preSet=null ) {
@@ -4650,7 +4645,7 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.8 - 2008-10-22
- * @param array $recurlabel
+ * @param string $recurlabel
  * @param array $recurdata
  * @return string
  */
@@ -5196,6 +5191,10 @@ 
     else
       return FALSE;
   }
+
+  /**
+   * @param integer $wkst
+   */
   function _recurIntervalIx( $freq, $date, $wkst ) {
             /* create interval index */
     switch( $freq ) {
@@ -5504,7 +5503,6 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.4.16 - 2008-10-19
- * @param string $offset
  * @return integer
  */
   function _tz2offset( $tz ) {
@@ -5966,8 +5964,8 @@ 
  * @since 2.5.1 - 2008-11-02
  * @param string $propName, optional
  * @param int @propix, optional, if specific property is wanted in case of multiply occurences
- * @param bool $inclParam=FALSE
- * @param bool $specform=FALSE
+ * @param bool $inclParam
+ * @param bool $specform
  * @return mixed
  */
   function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE, $specform=FALSE ) {
@@ -6160,9 +6158,6 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.5.1 - 2008-11-05
- * @param mixed $args variable number of function arguments,
- *                    first argument is ALWAYS component name,
- *                    second ALWAYS component value!
  * @return void
  */
   function setProperty() {
@@ -6276,7 +6271,7 @@ 
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.5.2 - 2008-10-23
  * @param mixed $unparsedtext, optional, strict rfc2445 formatted, single property string or array of property strings
- * @return bool FALSE if error occurs during parsing
+ * @return boolean|null FALSE if error occurs during parsing
  *
  */
   function parse( $unparsedtext=null ) {
@@ -6578,7 +6573,7 @@ 
  * @since 2.5.1 - 2008-10-15
  * @param mixed $arg1 ordno / component type / component uid
  * @param mixed $arg2 optional, ordno if arg1 = component type
- * @return void
+ * @return boolean
  */
   function deleteComponent( $arg1, $arg2=FALSE  ) {
     if( !isset( $this->components )) return FALSE;
@@ -6781,7 +6776,7 @@ 
  *
  * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
  * @since 2.2.8 - 2006-09-03
- * @param string $value
+ * @param string $string
  * @return string
  */
   function _size75( $string ) {