• Home
• Horde_Date_Recurrence

PHP Class Horde_Date_Recurrence, horde

All methods expecting dates as parameters accept all values that the Horde_Date constructor accepts, i.e. a timestamp, another Horde_Date object, an ISO time string or a hash. Mostra file Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$completions	array	All the dates this recurrence has been marked as completed.
$exceptions	array	All the exceptions from recurrence for this event.
$recurCount	integer	The number of recurrences.
$recurData	integer	Any additional recurrence data.
$recurEnd	Horde_Date	The end date of the recurrence interval.
$recurInterval	integer	The length of time between recurrences. The time unit depends on the recurrence type.
$recurType	integer	The type of recurrence this event follows. RECUR_* constant.
$start	Horde_Date	The start time of the event.

Public Methods

Method	Description
__construct ( Horde_Date $start )	Constructor.
addCompletion ( integer $year, integer $month, integer $mday )	Adds a completion to a recurring event.
addException ( integer $year, integer $month, integer $mday )	Adds an exception to a recurring event.
deleteCompletion ( integer $year, integer $month, integer $mday )	Deletes a completion from a recurring event.
deleteException ( integer $year, integer $month, integer $mday )	Deletes an exception from a recurring event.
fromKolab ( array $hash ) : boolean	Parses the recurrence data from a Kolab hash.
fromRRule10 ( string $rrule )	Parses a vCalendar 1.0 recurrence rule.
fromRRule20 ( string $rrule )	Parses an iCalendar 2.0 recurrence rule.
getCompletions ( ) : array	Retrieves all the completions for this event.
getExceptions ( ) : array	Retrieves all the exceptions for this event.
getRecurCount ( ) : integer	Retrieves the number of recurrences of this event.
getRecurEnd ( ) : Horde_Date	Retrieves the end date of the recurrence interval.
getRecurInterval ( ) : integer	Retrieves the length of time between recurrences of this event.
getRecurName ( ) : string	Returns a description of this event's recurring type.
getRecurOnDays ( ) : integer	Returns the days this event recurs on.
getRecurStart ( ) : Horde_Date	Retrieves the start date of the recurrence interval.
getRecurType ( ) : integer	Returns recurrence type of this event.
hasActiveRecurrence ( ) : boolean	Returns whether this event has any date that matches the recurrence rules and is not an exception.
hasCompletion ( integer $year, integer $month, integer $mday ) : boolean	Checks if a completion exists for a given reccurence of an event.
hasException ( integer $year, integer $month, integer $mday ) : boolean	Checks if an exception exists for a given reccurence of an event.
hasRecurCount ( ) : boolean	Returns whether this event has a recurrence with a fixed count.
hasRecurEnd ( ) : boolean	Returns whether this event has a recurrence end.
hasRecurType ( integer $recurrence ) : boolean	Returns whether this event has a specific recurrence type.
isEqual ( Horde_Date_Recurrence $recurrence ) : boolean	Return whether or not this object is equal to another recurrence object.
nextActiveRecurrence ( Horde_Date $afterDate ) : Horde_Date | boolean	Returns the next active recurrence.
nextRecurrence ( Horde_Date | string $after ) : Horde_Date | boolean	Finds the next recurrence of this event that's after $afterDate.
recurOnDay ( integer $dayMask ) : boolean	Checks if this event recurs on a given day of the week.
reset ( )	Resets the class properties.
setRecurCount ( integer $count )	Sets the number of recurrences of this event.
setRecurEnd ( Horde_Date $end )	Sets the end date of the recurrence interval.
setRecurInterval ( integer $interval )	Sets the length of time between recurrences of this event.
setRecurOnDay ( integer $dayMask )	Specifies the days this event recurs on.
setRecurStart ( Horde_Date $start )	Sets the start date of the recurrence interval.
setRecurType ( integer $recurrence )	Sets a recurrence type for this event.
toJson ( ) : object	Returns a simple object suitable for json transport representing this object.
toKolab ( ) : array	Export this object into a Kolab hash.
toRRule10 ( Horde_Icalendar $calendar ) : string	Creates a vCalendar 1.0 recurrence rule.
toRRule20 ( Horde_Icalendar $calendar ) : string	Creates an iCalendar 2.0 recurrence rule.
toString ( $date_format ) : string	Output a human readable description of the recurrence rule.

Protected Methods

Method	Description
_formatExceptionDate ( string $date, string $format ) : string	Returns a correcty formatted exception date for recurring events.

Method Details

Property Details