PHP Class Horde_Kolab_FreeBusy_Object_Event, horde

Copyright 1999-2016 Horde LLC (http://www.horde.org/) Copyright 2004-2008 Klarälvdalens Datakonsult AB Copyright 2011 Kolab Systems AG See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

See link: http://pear.horde.org/index.php?package=Kolab_FreeBusy

Author: Chuck Hagenbuch ([email protected])

Author: Jan Schneider ([email protected])

Author: Gunnar Wrobel ([email protected])

Mostra file Open project: horde/horde Class Usage Examples

Public Methods

Method	Description
__construct ( array $event )	Constructor.
duration ( ) : integer	Return the duration of the event.
getBusyTimes ( Horde_Date $startDate, Horde_Date $endDate ) : array	Retrieve the busy times from this event within the given timeframe. This is trivial for non-recurring events but recurring events need to be expanded.
getEncodedInformation ( ) : array	Return event details encoded for integration into the free/busy output.
getStatus ( ) : string	Return the event status (one of the event status codes defined in this class).
recurs ( ) : boolean	Returns whether this event is a recurring event.
recursIn ( Horde_Date $startDate, Horde_Date $endDate ) : boolean	Determines if the event recurs in the given time span.

Method Details

__construct() public method

Constructor.

public __construct ( array $event )
$event	array	The event data.

duration() public method

Return the duration of the event.

public duration ( ) : integer
return	integer	The duration (in seconds) of the event.

getBusyTimes() public method

Retrieve the busy times from this event within the given timeframe. This is trivial for non-recurring events but recurring events need to be expanded.

public getBusyTimes ( Horde_Date $startDate, Horde_Date $endDate ) : array
$startDate	Horde_Date	The start point.
$endDate	Horde_Date	The end point.
return	array	The list of busy times (only the start times of the event).

getEncodedInformation() public method

Return event details encoded for integration into the free/busy output.

public getEncodedInformation ( ) : array
return	array	The encoded free/busy information.

getStatus() public method

Return the event status (one of the event status codes defined in this class).

public getStatus ( ) : string
return	string	The status of this event.

recurs() public method

Returns whether this event is a recurring event.

public recurs ( ) : boolean
return	boolean	True if this is a recurring event.

recursIn() public method

Determines if the event recurs in the given time span.

public recursIn ( Horde_Date $startDate, Horde_Date $endDate ) : boolean
$startDate	Horde_Date	Start of the time span.
$endDate	Horde_Date	End of the time span.
return	boolean	True if the event recurs in this time span.