• Inicio
• Kronolith_Event

PHP Class Kronolith_Event, horde

Mostrar archivo Open project: horde/horde Class Usage Examples

Public Properties

Property	Type	Description
$alarm	integer	Number of minutes before the event starts to trigger an alarm.
$allday	boolean	Whether this is an all-day event.
$attendees	Kronolith_Attendee_List	All the attendees of this event.
$baseid	string	The baseid. For events that represent exceptions this is the UID of the original, recurring event.
$calendar	string	The identifier of the calender this event exists on.
$calendarType	string	The type of the calender this event exists on.
$created	Horde_Date	The creation time.
$createdby	string	The creator string.
$description	string	The description for this event.
$durMin	integer	The duration of this event in minutes
$end	Horde_Date	The end time of the event.
$exceptionoriginaldate	Horde_Date	For exceptions, the date of the original recurring event that this is an exception for.
$first	boolen	Whether this is the event on the first day of a multi-day event.
$icon	string	URL to an icon of this event.
$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.
$last	boolen	Whether this is the event on the last day of a multi-day event.
$location	string	The location this event occurs at.
$methods	array	The particular alarm methods overridden for this event.
$modified	Horde_Date	The last modification time.
$modifiedby	string	The last-modifier string.
$organizer	string	The email address of the organizer of the event, if known.
$private	boolean	Whether the event is private.
$recurrence	Horde_Date_Recurrence	The Horde_Date_Recurrence class for this event.
$recurrenceid	integer	The iCalendar RECURRENCE-ID for this event exception.
$sequence	integer	The iCalendar SEQUENCE for this event.
$start	Horde_Date	The start time of the event.
$status	integer	The status of this event.
$stored	boolean	Flag that is set to true if this event exists in a storage driver.
$timezone	string	The timezone of this event.
$title	string	For displaying in the interface use getTitle() instead.
$uid	string	The UID for this event.
$url	string	URL of this event.

Protected Properties

Property	Type	Description
$_backgroundColor	string	The HTML background color to be used for this event.
$_creator	string	The user id of the creator of the event.
$_duration	stdClass	The cached event duration, split up in time units.
$_foregroundColor	string	The HTML foreground color to be used for this event.
$_geoLocation	array	Geolocation
$_id	string	The driver unique identifier for this event.
$_indent	integer	Used in view renderers.
$_internaltags	array	Event tags from the storage backend (e.g. Kolab)
$_originalEnd	Horde_Date	The original end time of the event.
$_originalStart	Horde_Date	This may differ from $start on multi-day events where $start is the start time on the current day. For recurring events this is the start time of the current recurrence.
$_overlap	integer	Used in view renderers.
$_resources	array	This is an associative array where keys are resource uids, values are associative arrays with keys attendance and response.
$_rowspan	integer	Used in view renderers.
$_snooze	integer	Snooze minutes for this event's alarm.
$_span	integer	Used in view renderers.
$_tags	array | string	This tag's events.
$_vfs	Horde_Vfs	VFS handler

Public Methods

Method	Description
__construct ( Kronolith_Driver $driver, mixed $eventObject = null )	Constructor.
__get ( string $name ) : mixed	Getter.
__set ( string $name, mixed $value )	Setter.
addAttendee ( string $email, integer $role, integer | boolean $response, string $name = null )	Adds a new attendee to the current event.
addEASFiles ( $message )
addFile ( array $info )	Saves a file into the VFS backend associated with this event.
addFileFromData ( $info )
addResource ( Kronolith_Resource $resource, $response )	Adds a single resource to this event.
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.
deleteFile ( string $file )	Deletes a file from the VFS backend associated with this event.
deleteFiles ( )	Deletes all files from the VFS backend associated with this event.
disconnectExceptions ( boolean $delete = false )	Disconnect any existing exceptions.
exceptionLink ( string $date ) : string	Returns a correcty formatted exception date for recurring events and a link to delete this exception.
exceptionsList ( ) : string	Returns a list of exception dates for recurring events including links to delete them.
exists ( ) : boolean	Checks if the current event is already present in the calendar.
fromASAppointment ( Horde_ActiveSync_Message_Appointment $message )	Imports the values for this event from a MS ActiveSync Message.
fromDriver ( $event )	Imports a backend specific event object.
fromHash ( array $hash )	Imports the values for this event from an array of values.
fromiCalendar ( Horde_Icalendar_Vevent $vEvent, boolean $parseAttendees = false )	Updates the properties of this event from a Horde_Icalendar_Vevent object.
getCSSColors ( boolean $with_attribute = true ) : string	Returns the CSS color definition for this event.
getDeleteUrl ( array $params = [], $full = false ) : Horde_Url
getDriver ( ) : Kronolith_Driver	Returns a reference to a driver that's valid for this event.
getDuration ( )
getEditUrl ( array $params = [], $full = false ) : Horde_Url
getExportUrl ( array $params = [], $full = false ) : Horde_Url
getLink ( $datetime = null, $icons = true, $from_url = null, $full = false, $encoded = true )
getLocation ( string $user = null ) : string	Returns the location of this event, considering private flags.
getRecurName ( ) : string	Returns a description of this event's recurring type.
getResources ( ) : array	Returns all resources.
getShare ( ) : Horde_Share	Returns the share this event belongs to.
getStatusClass ( ) : string
getTimeRange ( ) : string
getTitle ( string $user = null ) : string	Returns the title of this event, considering private flags.
getTooltip ( ) : string
getVfsUid ( ) : string	Return a unique id suitable for identifying this event in the VFS. Takes into account there may be multiple users with access to the same UID in different calendars.
getViewUrl ( array $params = [], $full = false, $encoded = true ) : Horde_Url
hasAttendee ( string $email, boolean $case_sensitive = false, array $attendees = null ) : boolean	Checks to see whether the specified attendee is associated with the current event.
hasPermission ( integer $permission, string $user = null ) : boolean	Encapsulates permissions checking.
html ( $property )
isAllDay ( )
isPrivate ( string $user = null ) : boolean	Returns whether the event should be considered private.
listFiles ( ) : array	Returns all files from the VFS backend associated with this event.
loadHistory ( )	Retrieves history information for this event from the history backend.
readForm ( Kronolith_Event $existing = null )	Reads form/post data and updates this event's properties.
readRecurrenceForm ( $start, $timezone, $recurrence = null )
recurs ( ) : boolean	Returns whether this event is a recurring event.
removeResource ( Kronolith_Resource $resource )	Removes a resource from this event.
save ( ) : integer	Saves changes to this event.
setResources ( array $resources )	Set the entire resource array. Only used when copying an Event.
setTimezone ( $to_original )	Converts this event between the event's and the local timezone.
synchronizeTags ( array $tags )	Syncronizes tags from the tagging backend with the task storage backend, if necessary.
toASAppointment ( array $options = [] ) : Horde_ActiveSync_Message_Appointment	Export this event as a MS ActiveSync Message
toAlarm ( Horde_Date $time, string $user = null, Prefs $prefs = null ) : array	Returns an alarm hash of this event suitable for Horde_Alarm.
toJson ( array $options = [] ) : stdClass	Returns a simple object suitable for json transport representing this event.
toiCalendar ( Horde_Icalendar $calendar, boolean $includeFiles = true ) : array	Exports this event in iCalendar format.
vfsDisplayUrl ( array $file ) : string	Returns a link to display and download a file from the VFS backend associated with this object.
vfsEditUrl ( array $file ) : string	Returns a link to display, download, and delete a file from the VFS backend associated with this object.
vfsInit ( ) : Horde_Vfs	Loads the VFS configuration and initializes the VFS backend.

Protected Methods

Method	Description
_addEASFile ( Horde_ActiveSync_Message_AirSyncBaseAdd $add )
_formIDEncode ( $id )
_getEASFileReference ( $filename )
_handleEas16Exception ( Horde_ActiveSync_Message_Appointment $message ) : boolean	Handle adding/editing exceptions from EAS 16.0 clients.
_handleResources ( Kronolith_Event $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.
_handlevEventRecurrence ( Horde_Icalendar $vEvent )	Handle parsing recurrence related fields.

Method Details

Property Details