chamilo / chamilo-lms

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'))
@@ -2311,7 +2308,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 ))
@@ -2794,7 +2791,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 ))
@@ -3215,7 +3212,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
@@ -3253,7 +3249,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;
@@ -3376,7 +3372,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;
@@ -3802,7 +3798,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;
@@ -3931,7 +3927,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;
@@ -4098,7 +4094,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() ) {
@@ -4140,7 +4136,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
      */
@@ -4196,7 +4191,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 ) {
@@ -4230,7 +4224,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;
@@ -4580,6 +4574,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 ) {
@@ -4689,7 +4684,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
      */
@@ -5229,6 +5224,10 @@ 
         else
             return FALSE;
     }
+
+    /**
+     * @param integer $wkst
+     */
     function _recurIntervalIx( $freq, $date, $wkst ) {
         /* create interval index */
         switch( $freq ) {
@@ -5537,7 +5536,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.16 - 2008-10-19
-     * @param string $offset
      * @return integer
      */
     function _tz2offset( $tz ) {
@@ -5999,8 +5997,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 ) {
@@ -6193,9 +6191,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() {
@@ -6309,7 +6304,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 ) {
@@ -6611,7 +6606,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;
@@ -6814,7 +6809,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 ) {