Class Horde_Kolab_FreeBusy_Object_Event

Description

A reduced event representation derived from the Kronolith event representation.

$Horde: framework/Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Object/Event.php,v 1.1.2.1 2010-10-10 16:26:48 wrobel Exp $

Copyright 2004-2008 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_FreeBusy/lib/Horde/Kolab/FreeBusy/Object/Event.php (line 17)


	
			
Class Constant Summary
Variable Summary
Method Summary
 Horde_Kolab_FreeBusy_Object_Event __construct ( $event)
 void duration ()
 void getBusyTimes ( $startDate,  $endDate)
 boolean hasStatus (integer $status)
 void isFree ()
 boolean recurs ()
 boolean recursIn ( $startDate,  $endDate)
 void setUID (string $uid)
Variables
Horde_Date $end (line 45)

The end time of the event.

string $eventID = null (line 31)

The driver unique identifier for this event.

string $location = '' (line 59)

The location this event occurs at.

boolean $private = false (line 66)

Whether the event is private.

Horde_Date $start (line 38)

The start time of the event.

string $title = '' (line 52)

The title of this event.

Methods
Constructor __construct (line 68)
  • access: public
Horde_Kolab_FreeBusy_Object_Event __construct ( $event)
  • array $event
duration (line 176)
  • access: public
void duration ()
getBusyTimes (line 198)
  • access: public
void getBusyTimes ( $startDate,  $endDate)
getEncodedInformation (line 181)
  • access: public
void getEncodedInformation ()
hasStatus (line 171)

Checks whether the events status is the same as the specified value.

  • return: True if the events status is the same as $status.
boolean hasStatus (integer $status)
  • integer $status: The status value to check against.
isFree (line 190)
  • access: public
void isFree ()
recurs (line 148)

Returns whether this event is a recurring event.

  • return: True if this is a recurring event.
boolean recurs ()
recursIn (line 122)

Determines if the event recurs in the given time span.

  • return: True if the event recurs in this time span.
  • access: public
boolean recursIn ( $startDate,  $endDate)
setUID (line 159)

Sets the global UID for this event.

void setUID (string $uid)
  • string $uid: The global UID for this event.
Class Constants
STATUS_CANCELLED = 3 (line 23)
STATUS_CONFIRMED = 2 (line 22)
STATUS_FREE = 4 (line 24)
STATUS_NONE = 0 (line 20)

Event status - Taken from Kronolith

STATUS_TENTATIVE = 1 (line 21)

Documentation generated on Sun, 30 Jan 2011 05:17:10 +0000 by phpDocumentor 1.4.3