\Kronolith

permissionToJson()

permissionToJson(\Horde_Perms_Permission  $perm, boolean  $systemShare = false) : array

Converts a permission object to a json object.

This methods filters out any permissions for the owner and converts the user name if necessary.

Parameters

Returns

A hash suitable for json.

listAlarms()

listAlarms(\Horde_Date  $date, array  $calendars, boolean  $fullevent = false) : array

Returns all the alarms active on a specific date.

Parameters

Throws

\Kronolith_Exception

Returns

The alarms active on the date. A hash with calendar names as keys and arrays of events or event ids as values.

search()

search(object  $query, string  $calendar = null) : array

Searches for events with the given properties.

Parameters

Throws

\Kronolith_Exception

Returns

The events.

listEvents()

listEvents(\Horde_Date  $startDate, \Horde_Date  $endDate, array  $calendars = null, array  $options = array()) : array

Returns all the events that happen each day within a time period

Parameters

Returns

The events happening in this time period.

mergeEvents()

mergeEvents(array  $results, array  $events) 

Merges results from two listEvents() result sets.

Parameters

addEvents()

addEvents(  $results,   $event,   $startDate,   $endDate,   $showRecurrence,   $json,   $coverDates = true) 

Calculates recurrences of an event during a certain period.

Parameters

addCoverDates()

addCoverDates(  $results, \Kronolith_Event  $event, \Horde_Date  $eventStart, \Horde_Date  $eventEnd, boolean  $json, \Horde_Date  $originalStart = null, \Horde_Date  $originalEnd = null, \Horde_Date  $endDate = null) 

Adds an event to all the days it covers.

Parameters

addSearchEvents()

addSearchEvents(array  $events, \Kronolith_Event  $event, \stdClass  $query, boolean  $json) 

Adds an event to set of search results.

Parameters

countEvents()

countEvents() : integer

Returns the number of events in calendars that the current user owns.

Returns

The number of events.

quickAdd()

quickAdd(string  $text, string  $calendar = null) : array

Imports an event parsed from a string.

Parameters

Throws

\Kronolith_Exception

Returns

The UID of all events that were added.

initialize()

initialize() 

Initial app setup code.

Globals defined:

getUserName()

getUserName(  $uid) 

Returns the real name, if available, of a user.

Parameters

getUserEmail()

getUserEmail(  $uid) 

Returns the email address, if available, of a user.

Parameters

isUserEmail()

isUserEmail(string  $uid, string  $email) 

Checks if an email address belongs to a user.

Parameters

validateUserAttendee()

validateUserAttendee(string  $user) : mixed

Return Kronolith_Attendee object for a local user.

Parameters

Returns

Return the Kronolith_Attendee object for $user, or false if the auth backend supports user listing and the user is not found.

recurToString()

recurToString(integer  $type) : string

Maps a Kronolith recurrence value to a translated string suitable for display.

Parameters

Returns

The translated displayable recurrence value string.

statusToString()

statusToString(integer  $status) : string

Maps a Kronolith meeting status string to a translated string suitable for display.

Parameters

Returns

The translated displayable meeting status string.

responseToString()

responseToString(integer  $response) : string

Maps a Kronolith attendee response string to a translated string suitable for display.

Parameters

Returns

The translated displayable attendee response string.

partToString()

partToString(integer  $part) : string

Maps a Kronolith attendee participation string to a translated string suitable for display.

Parameters

Returns

The translated displayable attendee participation string.

responseFromICal()

responseFromICal(string  $response) : string

Maps an iCalendar attendee response string to the corresponding Kronolith value.

Parameters

Returns

The Kronolith response value.

buildStatusWidget()

buildStatusWidget(string  $name, string  $current = self::STATUS_CONFIRMED, string  $any = false) : string

Builds the HTML for an event status widget.

Parameters

Returns

The HTML widget.

listInternalCalendars()

listInternalCalendars(boolean  $owneronly = false, integer  $permission = \Horde_Perms::SHOW, string  $user = null) : array

Returns all internal calendars a user has access to, according to several parameters/permission levels.

This method takes the $conf['share']['hidden'] setting into account. If this setting is enabled, even if requesting permissions different than SHOW, it will only return calendars that the user owns or has SHOW permissions for. For checking individual calendar's permissions, use hasPermission() instead.

Parameters

boolean	$owneronly	Only return calenders that this user owns? Defaults to false.
integer	$permission	The permission to filter calendars by.
string	$user	The user to list calendars for, if not the current.

Returns

array —

The calendar list.

listCalendars()

listCalendars(integer  $permission = \Horde_Perms::SHOW, boolean  $display = false) : array

Returns all calendars a user has access to, according to several parameters/permission levels.

Parameters

integer	$permission	The permission to filter calendars by.
boolean	$display	Only return calendars that are supposed to be displayed per configuration and user preference.

Returns

array —

The calendar list.

getDefaultCalendar()

getDefaultCalendar(integer  $permission = \Horde_Perms::SHOW, boolean  $owner_only = false) : string

Returns the default calendar for the current user at the specified permissions level.

Parameters

integer	$permission	Horde_Perms constant for permission level required.
boolean	$owner_only	Only consider owner-owned calendars.

Returns

string —

The calendar id, or null if none.

getSyncCalendars()

getSyncCalendars(boolean  $prune = false) : array

Returns the calendars that should be used for syncing.

Parameters

boolean

$prune

Remove calendar ids from the sync list that no longer exist. The values are pruned after the results are passed back to the client to give sync clients a chance to remove their entries.

Returns

array —

An array of calendar ids

addCalendarLinks()

addCalendarLinks() 

Adds <link> tags for calendar feeds to the HTML header.

getLabel()

getLabel(  $calendar) : string

Returns the label to be used for a calendar.

Attaches the owner name of shared calendars if necessary.

Parameters

$calendar

Returns

string —

The calendar's label.

hasPermission()

hasPermission(string  $calendar, integer  $perm) : boolean

Returns whether the current user has certain permissions on a calendar.

Parameters

string	$calendar	A calendar id.
integer	$perm	A Horde_Perms permission mask.

Returns

boolean —

True if the current user has the requested permissions.

addShare()

addShare(array  $info) : \Horde_Share

Creates a new share.

Parameters

array

$info

Hash with calendar information.

Throws

\Kronolith_Exception

Returns

\Horde_Share —

The new share.

updateShare()

updateShare(  $calendar, array  $info) 

Updates an existing share.

Parameters

	$calendar
array	$info	Hash with calendar information.

Throws

\Kronolith_Exception

deleteShare()

deleteShare(\Horde_Share  $calendar) 

Deletes a share and removes all events associated with it.

Parameters

\Horde_Share

$calendar

The share to delete.

Throws

\Kronolith_Exception

listShareUsers()

listShareUsers(\Horde_Share_Object  $share) : array

Returns a list of user with read access to a share.

Parameters

\Horde_Share_Object

$share

A share object.

Returns

array —

A hash of share users.

readPermsForm()

readPermsForm(\Horde_Share_Object|\Kronolith_Resource_Base  $share) : array

Reads a submitted permissions form and updates the share permissions.

Parameters

\Horde_Share_Object|\Kronolith_Resource_Base

$share

The share to update.

Throws

\Kronolith_Exception

Returns

array —

A list of error messages.

subscribeRemoteCalendar()

subscribeRemoteCalendar(array  $info, string  $update = false) 

Subscribes to or updates a remote calendar.

Parameters

array	$info	Hash with calendar information.
string	$update	If present, the original URL of the calendar to update.

Throws

\Kronolith_Exception

unsubscribeRemoteCalendar()

unsubscribeRemoteCalendar(string  $url) : array

Unsubscribes from a remote calendar.

Parameters

string

$url

The calendar URL.

Throws

\Kronolith_Exception

Returns

array —

Hash with the deleted calendar's information.

feedUrl()

feedUrl(string  $calendar) : string

Returns the feed URL for a calendar.

Parameters

string

$calendar

A calendar name.

Returns

string —

The calendar's feed URL.

embedCode()

embedCode(string  $calendar) : string

Returs the HTML/javascript snippit needed to embed a calendar in an external website.

Parameters

string

$calendar

A calendar name.

Returns

string —

The calendar's embed snippit.

attendeeList()

attendeeList() : string

Returns a comma separated list of attendees and resources

Returns

string —

Attendee/Resource list.

sendITipNotifications()

sendITipNotifications(\Kronolith_Event  $event, \Horde_Notification_Handler  $notification, integer  $action, \Horde_Date  $instance = null, string  $range = null, \Kronolith_Attendee_List  $cancellations = null) 

Sends out iTip event notifications to all attendees of a specific event.

Can be used to send event invitations, event updates as well as event cancellations.

Parameters

\Kronolith_Event	$event	The event in question.
\Horde_Notification_Handler	$notification	A notification object used to show result status.
integer	$action	The type of notification to send. One of the Kronolith::ITIP_* values.
\Horde_Date	$instance	If cancelling a single instance of a recurring event, the date of this instance.
string	$range	The range parameter if this is a recurring event. Possible values are self::RANGE_THISANDFUTURE
\Kronolith_Attendee_List	$cancellations	If $action is 'CANCEL', but it is due to removing attendees and not canceling the entire event, these are the uninvited attendees and are the ONLY people that will receive the CANCEL iTIP. @since 4.2.10

sendNotification()

sendNotification(\Kronolith_Event  $event, string  $action) 

Sends email notifications that a event has been added, edited, or deleted to users that want such notifications.

Parameters

\Kronolith_Event	$event	An event.
string	$action	The event action. One of "add", "edit", or "delete".

Throws

\Horde_Mime_Exception

\Kronolith_Exception

notifyOfResourceRejection()

notifyOfResourceRejection(\Kronolith_Event  $event) 

Check for resource declines and push notice to stack if found.

Parameters

\Kronolith_Event

$event

Throws

\Kronolith_Exception

_notificationPref()

_notificationPref(string  $user, string  $mode, string  $calendar = null) : mixed

Returns whether a user wants email notifications for a calendar.

Parameters

string	$user	A user name.
string	$mode	The check "mode". If "owner", the method checks if the user wants notifications only for calendars he owns. If "read", the method checks if the user wants notifications for all calendars he has read access to, or only for shown calendars and the specified calendar is currently shown.
string	$calendar	The name of the calendar if mode is "read".

Returns

mixed —

The user's email, time, and language preferences if they want a notification for this calendar.

buildMimeMessage()

buildMimeMessage(\Horde_View  $view, string  $template, \Horde_Mime_Part  $image) : \Horde_Mime_Part

Builds the body MIME part of a multipart message.

Parameters

\Horde_View	$view	A view to render the HTML and plain text templates for the messate.
string	$template	The template base name for the view.
\Horde_Mime_Part	$image	The MIME part of a related image.

Returns

\Horde_Mime_Part —

A multipart/alternative MIME part.

getImagePart()

getImagePart(string  $file) : \Horde_Mime_Part

Returns a MIME part for an image to be embedded into a HTML document.

Parameters

string

$file

An image file name.

Returns

\Horde_Mime_Part —

A MIME part representing the image.

currentDate()

currentDate() : \Horde_Date

Returns

\Horde_Date

parseDate()

parseDate(string  $date, boolean  $withtime = true,   $timezone = null) : \Horde_Date

Parses a complete date-time string into a Horde_Date object.

Parameters

string	$date	The date-time string to parse.
boolean	$withtime	Whether time is included in the string.
	$timezone

Throws

\Horde_Date_Exception

Returns

\Horde_Date —

The parsed date.

tabs()

tabs(object  $renderer) 

Parameters

object

$renderer

A Kronolith view.

eventTabs()

eventTabs(string  $tabname, \Kronolith_Event  $event) 

Parameters

string	$tabname
\Kronolith_Event	$event

getDriver()

getDriver(string  $driver = null, string  $calendar = null) : \Kronolith_Driver

Attempts to return a single, concrete Kronolith_Driver instance based on a driver name.

This singleton method automatically retrieves all parameters required for the specified driver.

Parameters

string	$driver	The type of concrete Kronolith_Driver subclass to return.
string	$calendar	The calendar name. The format depends on the driver being used.

Throws

\Kronolith_Exception

Returns

\Kronolith_Driver —

The newly created concrete Kronolith_Driver instance.

getCalendar()

getCalendar(\Kronolith_Driver  $driver) : \Kronolith_Calendar

Returns a Kronolith_Calendar object for a driver instance.

Parameters

\Kronolith_Driver

$driver

Returns

\Kronolith_Calendar —

The matching calendar instance.

getRemoteParams()

getRemoteParams(  $calendar) 

Check for HTTP authentication credentials

Parameters

$calendar

displayedCalendars()

displayedCalendars() : array

Returns a list of currently displayed calendars.

Returns

array —

Currently displayed calendars.

getView()

getView(string  $view) 

Get a named Kronolith_View_* object and load it with the appropriate date parameters.

Parameters

string

$view

The name of the view.

viewShowLocation()

viewShowLocation() 

Should we show event location, based on the show_location pref?

viewShowTime()

viewShowTime() 

Should we show event time, based on the show_time preference?

backgroundColor()

backgroundColor(array|\Horde_Share_Object  $calendar) : string

Returns the background color for a calendar.

Parameters

array|\Horde_Share_Object

$calendar

A calendar share or a hash from a remote calender definition.

Returns

string —

A HTML color code.

foregroundColor()

foregroundColor(array|\Horde_Share_Object|string  $calendar) : string

Returns the foreground color for a calendar or a background color.

Parameters

array|\Horde_Share_Object|string

$calendar

A color string, a calendar share or a hash from a remote calender definition.

Returns

string —

A HTML color code.

getCSSColors()

getCSSColors(array|\Horde_Share_Object  $calendar, boolean  $with_attribute = true) : string

Returns the CSS color definition for a calendar.

Parameters

array|\Horde_Share_Object	$calendar	A calendar share or a hash from a remote calender definition.
boolean	$with_attribute	Whether to wrap the colors inside a "style" attribute.

Returns

string —

A CSS string with color definitions.

randomColor()

randomColor() : string

Returns a random CSS color.

Returns

string —

A random CSS color string.

showAjaxView()

showAjaxView() 

Returns whether to display the ajax view.

return boolean True if the ajax view should be displayed.

sortEvents()

sortEvents(array  $days) : array

Sorts an event list.

Parameters

array

$days

A list of days with events.

Returns

array —

The sorted day list.

getTagger()

getTagger() : \Kronolith_Tagger

Obtain a Kronolith_Tagger instance

Returns

\Kronolith_Tagger

getInternalCalendar()

getInternalCalendar(string  $target) : \Kronolith_Resource|\Horde_Share_Object

Obtain an internal calendar. Use this where we don't know if we will have a Horde_Share or a Kronolith_Resource based calendar.

Parameters

string

$target

The calendar id to retrieve.

Throws

\Kronolith_Exception

Returns

\Kronolith_Resource|\Horde_Share_Object

getAddressbookSearchParams()

getAddressbookSearchParams() : array

Determines parameters needed to do an address search

Returns

array —

An array with two keys: 'fields' and 'sources'.

hasApiPermission()

hasApiPermission(string  $api, integer  $perm = \Horde_Perms::READ) : boolean

Checks whether an API (application) exists and the user has permission to access it.

Parameters

string	$api	The API (application) to check.
integer	$perm	The permission to check.

Returns

boolean —

True if the API can be accessed.

removeUserEvents()

removeUserEvents(string  $user) 

Remove all events owned by the specified user in all calendars.

Parameters

string

$user

The user name to delete events for.

Throws

\Kronolith_Exception

\Horde_Exception_NotFound

\Horde_Exception_PermissionDenied

toTimeslice()

toTimeslice(\Kronolith_Event  $event, integer  $type, string  $client) 

Exports an event to a timeslice.

Parameters

\Kronolith_Event	$event	An event.
integer	$type	A job type ID.
string	$client	A client ID.

_sortEventStartTime()

_sortEventStartTime(  $a,   $b) 

Used with usort() to sort events based on their start times.

Parameters

	$a
	$b

×

Kronolith.php