Docs For Class Kronolith

Kronolith_Event

Description

Kronolith_Event defines a generic API for events.

author: Jan Schneider <jan@horde.org>
author: Chuck Hagenbuch <chuck@horde.org>
since: Kronolith 0.1

Direct descendents

Class	Description
Kronolith_Event_holidays	Kronolith_Event defines a generic API for events.
Kronolith_Event_ical	Kronolith_Event defines a generic API for events.
Kronolith_Event_sql
Kronolith_Event_kolab_old	Kronolith_Event defines a generic API for events.
Kronolith_Event_kolab_new

Variable Summary

integer $alarm

array $attendees

string $category

string $creatorID

string $description

integer $durMin

Horde_Date $end

string $eventID

boolean $initialized

array $keywords

string $location

boolean $private

string $remoteCal

string $remoteUrl

Horde_Date $start

integer $status

boolean $stored

string $title

string $_calendar

integer $_sequence

string $_uid

Horde_UI_VarRenderer $_varRenderer

Method Summary

Kronolith_Event Kronolith_Event ( &$driver, [Kronolith_Event $eventObject = null], Kronolith_Driver $driver)

void addAttendee (string $email, integer $attendance, integer $response, [string $name = null])

string exceptionLink (string $date)

string exceptionsList ()

boolean exists ()

void fromHash (array $hash)

void fromiCalendar (Horde_iCalendar_vevent $vEvent)

void getAlarm ()

array getAttendees ()

void getCalendar ()

string getCategory ()

string getCreatorId ()

string getDeleteUrl ([array $params = array()])

string getDescription ()

Kronolith_Driver &getDriver ()

void getDuration ()

string getEditUrl ([array $params = array()])

string getExportUrl ([array $params = array()])

string getId ()

void getKeywords ()

void getLink ([ $timestamp = null], [ $icons = true], [ $from_url = null], [ $full = false])

string getLocation ()

string getRecurName ()

integer getSequence ()

Horde_Share &getShare ()

integer getStatus ()

string getStatusClass ()

string getTimeRange ()

string getTitle ([string $user = null])

string getTooltip ()

string getUID ()

string getViewUrl ([array $params = array()], [ $full = false])

boolean hasAttendee (string $email)

void hasKeyword ( $keyword)

boolean hasPermission (integer $permission, [string $user = null])

boolean hasStatus (integer $status)

void html ( $property)

void isAllDay ()

void isInitialized ()

boolean isPrivate ()

void isRemote ()

void isStored ()

void js ( $property)

void readForm ()

boolean recurs ()

void removeAttendee (string $email)

mixed save ()

void setAlarm ( $alarm)

void setAttendees (array $attendees)

void setCalendar ( $calendar)

void setCategory (string $category)

void setCreatorId (string $creatorID)

void setDescription (string $description)

void setId (string $eventId)

void setKeywords ( $keywords)

void setLocation (string $location)

void setPrivate (boolean $private)

void setStatus (integer $status)

void setTitle (string $title)

void setUID (string $uid)

array toAlarm (Horde_Date $time, [string $user = null], [Prefs $prefs = null])

Horde_iCalendar_vevent &toiCalendar (Horde_iCalendar &$calendar)

void _formIDEncode ( $id)

Variables

integer $alarm = 0 (line 418)

Number of minutes before the event starts to trigger an alarm.

array $attendees = array() (line 383)

All the attendees of this event.

This is an associative array where the keys are the email addresses of the attendees, and the values are also associative arrays with keys 'attendance' and 'response' pointing to the attendees' attendance and response values, respectively.

string $category = '' (line 329)

The category of this event.

string $creatorID = null (line 315)

The user id of the creator of the event.

string $description = '' (line 350)

The description for this event

integer $durMin = 0 (line 411)

The duration of this event in minutes

Horde_Date $end (line 404)

The end time of the event.

string $eventID = null (line 294)

The driver unique identifier for this event.

boolean $initialized = false (line 280)

Flag that is set to true if this event has data from either a storage backend or a form or other import method.

array $keywords = array() (line 390)

All the key words associtated with this event.

string $location = '' (line 336)

The location this event occurs at.

boolean $private = false (line 371)

Whether the event is private.

string $remoteCal = '' (line 364)

Remote calendar name.

string $remoteUrl = '' (line 357)

Remote description of this event (URL).

Horde_Date $start (line 397)

The start time of the event.

integer $status = KRONOLITH_STATUS_CONFIRMED (line 343)

The status of this event.

Redefined in descendants as:

Kronolith_Event_holidays::$status : The status of this event.

boolean $stored = false (line 287)

Flag that is set to true if this event exists in a storage driver.

string $title = '' (line 322)

The title of this event.

string $_calendar (line 425)

The identifier of the calender this event exists on.

integer $_sequence = null (line 308)

The iCalendar SEQUENCE for this event.

string $_uid = null (line 301)

The UID for this event.

Horde_UI_VarRenderer $_varRenderer (line 432)

The VarRenderer class to use for printing select elements.

Methods

Constructor Kronolith_Event (line 442)

Constructor.

Kronolith_Event Kronolith_Event ( &$driver, [Kronolith_Event $eventObject = null], Kronolith_Driver $driver)

Kronolith_Driver $driver: The backend driver that this event is stored in.
Kronolith_Event $eventObject: Backend specific event object that this will represent.
&$driver

addAttendee (line 1663)

Adds a new attendee to the current event.

This will overwrite an existing attendee if one exists with the same email address.

void addAttendee (string $email, integer $attendance, integer $response, [string $name = null])

string $email: The email address of the attendee.
integer $attendance: The attendance code of the attendee.
integer $response: The response code of the attendee.
string $name: The name of the attendee.

exceptionLink (line 1346)

Returns a correcty formatted exception date for recurring events and a link to delete this exception.

return: The formatted date and delete link.

string exceptionLink (string $date)

string $date: Exception in the format Ymd.

exceptionsList (line 1361)

Returns a list of exception dates for recurring events including links to delete them.

return: List of exception dates and delete links.

string exceptionsList ()

exists (line 1250)

Checks if the current event is already present in the calendar.

Does the check based on the uid.

return: True if event exists, false otherwise.

boolean exists ()

fromHash (line 1032)

Imports the values for this event from an array of values.

void fromHash (array $hash)

array $hash: Array containing all the values.

fromiCalendar (line 790)

Updates the properties of this event from a Horde_iCalendar_vevent object.

void fromiCalendar (Horde_iCalendar_vevent $vEvent)

Horde_iCalendar_vevent $vEvent: The iCalendar data to update from.

getAlarm (line 1723)

void getAlarm ()

getAttendees (line 1621)

Returns the entire attendees array.

return: A copy of the attendees array.

array getAttendees ()

getCalendar (line 1368)

void getCalendar ()

getCategory (line 1529)

Returns the category of this event.

return: The category of this event.

string getCategory ()

getCreatorId (line 1441)

Returns the id of the user who created the event.

return: The creator id

string getCreatorId ()

getDeleteUrl (line 2208)

string getDeleteUrl ([array $params = array()])

array $params

getDescription (line 1509)

Returns the description of this event.

return: The description of this event.

string getDescription ()

getDriver (line 461)

Returns a reference to a driver that's valid for this event.

return: A driver that this event can use to save itself, etc.

Kronolith_Driver &getDriver ()

getDuration (line 1265)

void getDuration ()

getEditUrl (line 2189)

string getEditUrl ([array $params = array()])

array $params

getExportUrl (line 2221)

string getExportUrl ([array $params = array()])

array $params

getId (line 1388)

Returns the locally unique identifier for this event.

return: The local identifier for this event.

string getId ()

getKeywords (line 1698)

void getKeywords ()

getLink (line 2235)

void getLink ([ $timestamp = null], [ $icons = true], [ $from_url = null], [ $full = false])

$timestamp
$icons
$from_url
$full

getLocation (line 1549)

Returns the location this event occurs at.

return: The location of this event.

string getLocation ()

getRecurName (line 1331)

Returns a description of this event's recurring type.

return: Human readable recurring type.

string getRecurName ()

getSequence (line 1431)

Returns the iCalendar SEQUENCE for this event.

return: The sequence for this event.

integer getSequence ()

getShare (line 476)

Returns the share this event belongs to.

return: This event's share.

Horde_Share &getShare ()

getStatus (line 1589)

Returns the event status.

return: The status of this event.

integer getStatus ()

getStatusClass (line 2409)

return: The CSS class for the event based on its status.

string getStatusClass ()

getTimeRange (line 2386)

return: The time range of the event ("All Day", "1:00pm-3:00pm", "08:00-22:00").

string getTimeRange ()

getTitle (line 1463)

Returns the title of this event.

return: The title of this event.

string getTitle ([string $user = null])

string $user: The current user.

Redefined in descendants as:

Kronolith_Event_holidays::getTitle() : Return this events title.

getTooltip (line 2363)

return: A tooltip for quick descriptions of this event.

string getTooltip ()

getUID (line 1411)

Returns the global UID for this event.

return: The global UID for this event.

string getUID ()

getViewUrl (line 2169)

string getViewUrl ([array $params = array()], [ $full = false])

array $params
$full

hasAttendee (line 1635)

Checks to see whether the specified attendee is associated with the current event.

return: True if the specified attendee is present for this event.

boolean hasAttendee (string $email)

string $email: The email address of the attendee.

hasKeyword (line 1703)

void hasKeyword ( $keyword)

$keyword

hasPermission (line 494)

Encapsulates permissions checking.

boolean hasPermission (integer $permission, [string $user = null])

integer $permission: The permission to check for.
string $user: The user to check permissions for.

hasStatus (line 1601)

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.

html (line 1950)

void html ( $property)

$property

isAllDay (line 1713)

void isAllDay ()

Redefined in descendants as:

Kronolith_Event_holidays::isAllDay() : Is this event an all-day event?

isInitialized (line 1230)

TODO

void isInitialized ()

isPrivate (line 1569)

Returns whether this event is private.

return: Whether this even is private.

boolean isPrivate ()

isRemote (line 1378)

void isRemote ()

isStored (line 1238)

TODO

void isStored ()

js (line 2136)

void js ( $property)

$property

readForm (line 1733)

void readForm ()

recurs (line 1320)

Returns whether this event is a recurring event.

return: True if this is a recurring event.

boolean recurs ()

removeAttendee (line 1690)

Removes the specified attendee from the current event.

void removeAttendee (string $email)

string $email: The email address of the attendee.

save (line 521)

Saves changes to this event.

return: True or a PEAR_Error on failure.

mixed save ()

setAlarm (line 1728)

void setAlarm ( $alarm)

$alarm

setAttendees (line 1647)

Sets the entire attendee array.

void setAttendees (array $attendees)

array $attendees: The new attendees array. This should be of the correct format to avoid driver problems.

setCalendar (line 1373)

void setCalendar ( $calendar)

$calendar

setCategory (line 1539)

Sets the category of this event.

void setCategory (string $category)

string $category: The category of this event.

setCreatorId (line 1451)

Sets the id of the creator of the event.

void setCreatorId (string $creatorID)

string $creatorID: The user id for the user who created the event

setDescription (line 1519)

Sets the description of this event.

void setDescription (string $description)

string $description: The new description for this event.

setId (line 1398)

Sets the locally unique identifier for this event.

void setId (string $eventId)

string $eventId: The local identifier for this event.

setKeywords (line 1708)

void setKeywords ( $keywords)

$keywords

setLocation (line 1559)

Sets the location this event occurs at.

void setLocation (string $location)

string $location: The new location for this event.

setPrivate (line 1579)

Sets the private flag of this event.

void setPrivate (boolean $private)

boolean $private: Whether this event should be marked private.

setStatus (line 1611)

Sets the status of this event.

void setStatus (integer $status)

integer $status: The new event status.

setTitle (line 1499)

Sets the title of this event.

void setTitle (string $title)

string $title: The new title for this event.

setUID (line 1421)

Sets the global UID for this event.

void setUID (string $uid)

string $uid: The global UID for this event.

toAlarm (line 1159)

Returns an alarm hash of this event suitable for Horde_Alarm.

return: Alarm hash or null.

array toAlarm (Horde_Date $time, [string $user = null], [Prefs $prefs = null])

Horde_Date $time: Time of alarm.
string $user: The user to return alarms for.
Prefs $prefs: A Prefs instance.

toiCalendar (line 555)

Exports this event in iCalendar format.

return: The vEvent object for this event.

Horde_iCalendar_vevent &toiCalendar (Horde_iCalendar &$calendar)

Horde_iCalendar &$calendar: A Horde_iCalendar object that acts as a container.

_formIDEncode (line 2423)

void _formIDEncode ( $id)

Documentation generated on Sun, 30 Jan 2011 05:31:45 +0000 by phpDocumentor 1.4.3