$initialized
$initialized : boolean
Flag that is set to true if this event has data from either a storage backend or a form or other import method.
Copyright 2006-2017 Horde LLC (http://www.horde.org/)
See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.
$attendees : \Kronolith_Attendee_List
All the attendees of this event.
__construct(\Kronolith_Driver $driver, mixed $eventObject = null)
Constructor.
| \Kronolith_Driver | $driver | The backend driver that this event is stored in. |
| mixed | $eventObject | Backend specific event object that this will represent. |
getDriver() : \Kronolith_Driver
Returns a reference to a driver that's valid for this event.
A driver that this event can use to save itself, etc.
toiCalendar(\Horde_Icalendar $calendar, boolean $includeFiles = true) : array
Exports this event in iCalendar format.
| \Horde_Icalendar | $calendar | A Horde_Icalendar object that acts as a container. |
| boolean | $includeFiles | Include attached files in the iCalendar file? @since 4.3.0 |
An array of Horde_Icalendar_Vevent objects for this event.
fromiCalendar(\Horde_Icalendar_Vevent $vEvent, boolean $parseAttendees = false)
Updates the properties of this event from a Horde_Icalendar_Vevent object.
| \Horde_Icalendar_Vevent | $vEvent | The iCalendar data to update from. |
| boolean | $parseAttendees | Parse attendees too? @since Kronolith 4.2 |
toASAppointment(array $options = array()) : \Horde_ActiveSync_Message_Appointment
Export this event as a MS ActiveSync Message
| array | $options | Options:
|
toAlarm(\Horde_Date $time, string $user = null, \Prefs $prefs = null) : array
Returns an alarm hash of this event suitable for Horde_Alarm.
| \Horde_Date | $time | Time of alarm. |
| string | $user | The user to return alarms for. |
| \Prefs | $prefs | A Prefs instance. |
Alarm hash or null.
toJson(array $options = array()) : \stdClass
Returns a simple object suitable for json transport representing this event.
Possible properties are:
| array | $options | An array of options:
|
A simple object.
boundExceptions(boolean $flat = true) : array
Returns a list of events that represent exceptions to this event's recurrence series, if any. If this event does not recur, an empty array is returned.
| boolean | $flat | If true (the default), returns a flat array containing Kronolith_Event objects. If false, results are in the format of listEvents calls. @see Kronolith::listEvents(). |
An array of Kronolith_Event objects whose baseid property is equal to this event's uid. I.e., it is a bound exception.
hasAttendee(string $email, boolean $case_sensitive = false, array $attendees = null) : boolean
Checks to see whether the specified attendee is associated with the current event.
| string | The email address of the attendee. |
|
| boolean | $case_sensitive | Match in a case sensitive manner. @since 4.3.0 |
| array | $attendees | Search that attendee list instead of this event's. @since 4.3.0 |
True if the specified attendee is present for this event.
addAttendee(string $email, integer $role, integer|boolean $response, string $name = null)
Adds a new attendee to the current event.
This will overwrite an existing attendee if one exists with the same email address.
| string | The email address of the attendee. |
|
| integer | $role | The role code of the attendee. |
| integer|boolean | $response | The response code of the attendee. |
| string | $name | The name of the attendee. |
addResource(\Kronolith_Resource $resource, $response)
Adds a single resource to this event.
No validation or acceptence/denial is done here...it should be done when saving the event.
| \Kronolith_Resource | $resource | The resource to add. |
| $response |
removeResource(\Kronolith_Resource $resource)
Removes a resource from this event.
| \Kronolith_Resource | $resource | The resource to remove. |
readForm(\Kronolith_Event|null $existing = null)
Reads form/post data and updates this event's properties.
| \Kronolith_Event|null | $existing | If this is an exception event this is taken as the base event. @since 4.2.6 |
_handleResources(\Kronolith_Event|null $existing = null)
Handles updating/saving this event's resources. Unless this event recurs, this will delete this event from any resource calendars that are no longer needed (as when a resource is removed from an existing event). If this event is an exception, i.e., contains a baseid, AND $existing is provided, the resources from the original event are used for purposes of determining any resources that need to be removed.
| \Kronolith_Event|null | $existing | An existing base event. |