Documentation

The user's email, time, and language preferences if they want a notification for this calendar. False if no notification should be sent.

The new share.

Attendee/Resource list.

A HTML color code.

A multipart/alternative MIME part.

The HTML widget. countEvents() Kronolith.php : 678 Returns the number of events in calendars that the current user owns. public static countEvents() : int Return values int — The number of events. currentDate() Kronolith.php : 2410 public static currentDate() : Horde_Date Return values Horde_Date — deleteShare() Kronolith.php : 1376 Deletes a share and removes all events associated with it. public static deleteShare(Horde_Share $calendar) : mixed Parameters $calendar : Horde_Share The share to delete. Tags throws Kronolith_Exception Return values mixed — displayedCalendars() Kronolith.php : 2702 Returns a list of currently displayed calendars. public static displayedCalendars() : array<string|int, mixed> Return values array<string|int, mixed> — Currently displayed calendars. embedCode() Kronolith.php : 1820 Returs the HTML/javascript snippit needed to embed a calendar in an external website. public static embedCode(string $calendar) : string Parameters $calendar : string A calendar name. Return values string — The calendar's embed snippit. eventTabs() Kronolith.php : 2552 public static eventTabs(string $tabname, Kronolith_Event $event) : mixed Parameters $tabname : string $event : Kronolith_Event Return values mixed — feedUrl() Kronolith.php : 1802 Returns the feed URL for a calendar. public static feedUrl(string $calendar) : string Parameters $calendar : string A calendar name. Return values string — The calendar's feed URL. foregroundColor() Kronolith.php : 2833 Returns the foreground color for a calendar or a background color. public static foregroundColor(array<string|int, mixed>|Horde_Share_Object|string $calendar) : string Parameters $calendar : array<string|int, mixed>|Horde_Share_Object|string A color string, a calendar share or a hash from a remote calender definition. Return values string — A HTML color code. getAddressbookSearchParams() Kronolith.php : 2951 Determines parameters needed to do an address search public static getAddressbookSearchParams() : array<string|int, mixed> Return values array<string|int, mixed> — An array with two keys: 'fields' and 'sources'. getCalendar() Kronolith.php : 2643 Returns a Kronolith_Calendar object for a driver instance. public static getCalendar(Kronolith_Driver $driver) : Kronolith_Calendar Parameters $driver : Kronolith_Driver Tags since Kronolith 4.0.1 Return values Kronolith_Calendar — The matching calendar instance. getCSSColors() Kronolith.php : 2849 Returns the CSS color definition for a calendar. public static getCSSColors(array<string|int, mixed>|Horde_Share_Object $calendar[, bool $with_attribute = true ]) : string Parameters $calendar : array<string|int, mixed>|Horde_Share_Object A calendar share or a hash from a remote calender definition. $with_attribute : bool = true Whether to wrap the colors inside a "style" attribute. Return values string — A CSS string with color definitions. getDefaultCalendar() Kronolith.php : 1164 Returns the default calendar for the current user at the specified permissions level. public static getDefaultCalendar([int $permission = Horde_Perms::SHOW ][, bool $owner_only = false ]) : string Parameters $permission : int = Horde_Perms::SHOW Horde_Perms constant for permission level required. $owner_only : bool = false Only consider owner-owned calendars. Return values string — The calendar id, or null if none. getDriver() Kronolith.php : 2616 Attempts to return a single, concrete Kronolith_Driver instance based on a driver name. public static getDriver([string $driver = null ][, string $calendar = null ]) : Kronolith_Driver This singleton method automatically retrieves all parameters required for the specified driver. Parameters $driver : string = null The type of concrete Kronolith_Driver subclass to return. $calendar : string = null The calendar name. The format depends on the driver being used. Tags throws Kronolith_Exception Return values Kronolith_Driver — The newly created concrete Kronolith_Driver instance. getImagePart() Kronolith.php : 2396 Returns a MIME part for an image to be embedded into a HTML document. public static getImagePart(string $file) : Horde_Mime_Part Parameters $file : string An image file name. Return values Horde_Mime_Part — A MIME part representing the image. getInternalCalendar() Kronolith.php : 2935 Obtain an internal calendar. Use this where we don't know if we will have a Horde_Share or a Kronolith_Resource based calendar. public static getInternalCalendar(string $target) : Kronolith_Resource|Horde_Share_Object Parameters $target : string The calendar id to retrieve. Tags throws Kronolith_Exception Return values Kronolith_Resource|Horde_Share_Object — getLabel() Kronolith.php : 1250 Returns the label to be used for a calendar. public static getLabel(mixed $calendar) : string Attaches the owner name of shared calendars if necessary. Parameters $calendar : mixed Return values string — The calendar's label. getRemoteParams() Kronolith.php : 2670 Check for HTTP authentication credentials public static getRemoteParams(mixed $calendar) : mixed Parameters $calendar : mixed Return values mixed — getSyncCalendars() Kronolith.php : 1200 Returns the calendars that should be used for syncing. public static getSyncCalendars([bool $prune = false ]) : array<string|int, mixed> Parameters $prune : bool = false 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. Return values array<string|int, mixed> — An array of calendar ids getTagger() Kronolith.php : 2918 Obtain a Kronolith_Tagger instance public static getTagger() : Kronolith_Tagger Return values Kronolith_Tagger — getUserEmail() Kronolith.php : 779 Returns the email address, if available, of a user. public static getUserEmail(mixed $uid) : mixed Parameters $uid : mixed Return values mixed — getUserName() Kronolith.php : 760 Returns the real name, if available, of a user. public static getUserName(mixed $uid) : mixed Parameters $uid : mixed Return values mixed — getView() Kronolith.php : 2727 Get a named Kronolith_View_* object and load it with the appropriate date parameters. public static getView(string $view) : mixed Parameters $view : string The name of the view. Return values mixed — hasApiPermission() Kronolith.php : 2978 Checks whether an API (application) exists and the user has permission to access it. public static hasApiPermission(string $api[, int $perm = Horde_Perms::READ ]) : bool Parameters $api : string The API (application) to check. $perm : int = Horde_Perms::READ The permission to check. Return values bool — True if the API can be accessed. hasPermission() Kronolith.php : 1268 Returns whether the current user has certain permissions on a calendar. public static hasPermission(string $calendar, int $perm) : bool Parameters $calendar : string A calendar id. $perm : int A Horde_Perms permission mask. Return values bool — True if the current user has the requested permissions. initialize() Kronolith.php : 752 Initial app setup code. public static initialize() : mixed Globals defined: Return values mixed — isUserEmail() Kronolith.php : 800 Checks if an email address belongs to a user. public static isUserEmail(string $uid, string $email) : mixed Parameters $uid : string user id to check $email : string email address to check Return values mixed — listAlarms() Kronolith.php : 126 Returns all the alarms active on a specific date. public static listAlarms(Horde_Date $date, array<string|int, mixed> $calendars[, bool $fullevent = false ]) : array<string|int, mixed> Parameters $date : Horde_Date The date to check for alarms. $calendars : array<string|int, mixed> The calendars to check for events. $fullevent : bool = false Whether to return complete alarm objects or only alarm IDs. Tags throws Kronolith_Exception Return values array<string|int, mixed> — The alarms active on the date. A hash with calendar names as keys and arrays of events or event ids as values. listCalendars() Kronolith.php : 1115 Returns all calendars a user has access to, according to several parameters/permission levels. public static listCalendars([int $permission = Horde_Perms::SHOW ][, bool $display = false ]) : array<string|int, mixed> Parameters $permission : int = Horde_Perms::SHOW The permission to filter calendars by. $display : bool = false Only return calendars that are supposed to be displayed per configuration and user preference. Return values array<string|int, mixed> — The calendar list. listEvents() Kronolith.php : 208 Returns all the events that happen each day within a time period public static listEvents(Horde_Date $startDate, Horde_Date $endDate[, array<string|int, mixed> $calendars = null ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed> Parameters $startDate : Horde_Date The start of the time range. $endDate : Horde_Date The end of the time range. $calendars : array<string|int, mixed> = null The calendars to check for events. $options : array<string|int, mixed> = array() Additional options: show_recurrence: (boolean) Return every instance of a recurring event? DEFAULT: false (Only return recurring events once inside $startDate - $endDate range) has_alarm: (boolean) Only return events with alarms. DEFAULT: false (Return all events) json: (boolean) Store the results of the event's toJson() method? DEFAULT: false cover_dates: (boolean) Add the events to all days that they cover? DEFAULT: true hide_exceptions: (boolean) Hide events that represent exceptions to a recurring event. DEFAULT: false (Do not hide exception events) fetch_tags: (boolean) Fetch tags for all events. DEFAULT: false (Do not fetch event tags) Tags deprecated Return values array<string|int, mixed> — The events happening in this time period. listInternalCalendars() Kronolith.php : 1039 Returns all internal calendars a user has access to, according to several parameters/permission levels. public static listInternalCalendars([bool $owneronly = false ][, int $permission = Horde_Perms::SHOW ][, string $user = null ]) : array<string|int, mixed> 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 $owneronly : bool = false Only return calenders that this user owns? Defaults to false. $permission : int = Horde_Perms::SHOW The permission to filter calendars by. $user : string = null The user to list calendars for, if not the current. Return values array<string|int, mixed> — The calendar list. listShareUsers() Kronolith.php : 1409 Returns a list of user with read access to a share. public static listShareUsers(Horde_Share_Object $share) : array<string|int, mixed> Parameters $share : Horde_Share_Object A share object. Return values array<string|int, mixed> — A hash of share users. mergeEvents() Kronolith.php : 310 Merges results from two listEvents() result sets. public static mergeEvents(array<string|int, mixed> &$results, array<string|int, mixed> $events) : mixed Parameters $results : array<string|int, mixed> First list of events. $events : array<string|int, mixed> List of events to be merged into the first one. Return values mixed — notifyOfResourceRejection() Kronolith.php : 2257 Check for resource declines and push notice to stack if found. public static notifyOfResourceRejection(Kronolith_Event $event) : mixed Parameters $event : Kronolith_Event Tags throws Kronolith_Exception Return values mixed — parseDate() Kronolith.php : 2432 Parses a complete date-time string into a Horde_Date object. public static parseDate(string $date[, bool $withtime = true ][, mixed $timezone = null ]) : Horde_Date Parameters $date : string The date-time string to parse. $withtime : bool = true Whether time is included in the string. $timezone : mixed = null Tags þaram string $timezone The timezone of the string. throws Horde_Date_Exception Return values Horde_Date — The parsed date. partToString() Kronolith.php : 938 Maps a Kronolith attendee participation string to a translated string suitable for display. public static partToString(int $part) : string Parameters $part : int The attendee participation; one of the Kronolith::PART_XXX constants. Return values string — The translated displayable attendee participation string. permissionToJson() Kronolith.php : 91 Converts a permission object to a json object. public static permissionToJson(Horde_Perms_Permission $perm[, bool $systemShare = false ]) : array<string|int, mixed> This methods filters out any permissions for the owner and converts the user name if necessary. Parameters $perm : Horde_Perms_Permission A permission object. $systemShare : bool = false Is this from a system share? Return values array<string|int, mixed> — A hash suitable for json. quickAdd() Kronolith.php : 715 Imports an event parsed from a string. public quickAdd(string $text[, string $calendar = null ]) : array<string|int, mixed> Parameters $text : string The text to parse into an event $calendar : string = null The calendar into which the event will be imported. If 'null', the user's default calendar will be used. Tags throws Kronolith_Exception Return values array<string|int, mixed> — The UID of all events that were added. randomColor() Kronolith.php : 2863 Returns a random CSS color. public static randomColor() : string Return values string — A random CSS color string. readPermsForm() Kronolith.php : 1443 Reads a submitted permissions form and updates the share permissions. public static readPermsForm(Horde_Share_Object|Kronolith_Resource_Base $share) : array<string|int, mixed> Parameters $share : Horde_Share_Object|Kronolith_Resource_Base The share to update. Tags throws Kronolith_Exception Return values array<string|int, mixed> — A list of error messages. recurToString() Kronolith.php : 850 Maps a Kronolith recurrence value to a translated string suitable for display. public static recurToString(int $type) : string Parameters $type : int The recurrence value; one of the Horde_Date_Recurrence::RECUR_XXX constants. Return values string — The translated displayable recurrence value string. removeUserEvents() Kronolith.php : 2993 Remove all events owned by the specified user in all calendars. public static removeUserEvents(string $user) : mixed Parameters $user : string The user name to delete events for. Tags throws Kronolith_Exception throws Horde_Exception_NotFound throws Horde_Exception_PermissionDenied Return values mixed — responseFromICal() Kronolith.php : 961 Maps an iCalendar attendee response string to the corresponding Kronolith value. public static responseFromICal(string $response) : string Parameters $response : string The attendee response. Return values string — The Kronolith response value. responseToString() Kronolith.php : 910 Maps a Kronolith attendee response string to a translated string suitable for display. public static responseToString(int $response) : string Parameters $response : int The attendee response; one of the Kronolith::RESPONSE_XXX constants. Return values string — The translated displayable attendee response string. search() Kronolith.php : 149 Searches for events with the given properties. public static search(object $query[, string $calendar = null ]) : array<string|int, mixed> Parameters $query : object The search query. $calendar : string = null The calendar to search in the form "Driver|calendar_id". Tags throws Kronolith_Exception Return values array<string|int, mixed> — The events. sendITipNotifications() Kronolith.php : 1885 Sends out iTip event notifications to all attendees of a specific event. public static sendITipNotifications(Kronolith_Event $event, Horde_Notification_Handler $notification, int $action[, Horde_Date $instance = null ][, string $range = null ][, Kronolith_Attendee_List $cancellations = null ]) : mixed Can be used to send event invitations, event updates as well as event cancellations. Parameters $event : Kronolith_Event The event in question. $notification : Horde_Notification_Handler A notification object used to show result status. $action : int The type of notification to send. One of the Kronolith::ITIP_* values. $instance : Horde_Date = null If cancelling a single instance of a recurring event, the date of this instance. $range : string = null The range parameter if this is a recurring event. Possible values are self::RANGE_THISANDFUTURE $cancellations : Kronolith_Attendee_List = null 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 Return values mixed — sendNotification() Kronolith.php : 2115 Sends email notifications that a event has been added, :q edited, or deleted to users that want such notifications. public static sendNotification(Kronolith_Event $event, string $action) : mixed Parameters $event : Kronolith_Event An event. $action : string The event action. One of "add", "edit", or "delete". Tags throws Horde_Mime_Exception throws Kronolith_Exception Return values mixed — showAjaxView() Kronolith.php : 2877 Returns whether to display the ajax view. public static showAjaxView() : mixed return boolean True if the ajax view should be displayed. Return values mixed — sortEvents() Kronolith.php : 2889 Sorts an event list. public static sortEvents(array<string|int, mixed> $days) : array<string|int, mixed> Parameters $days : array<string|int, mixed> A list of days with events. Return values array<string|int, mixed> — The sorted day list. statusToString() Kronolith.php : 883 Maps a Kronolith meeting status string to a translated string suitable for display. public static statusToString(int $status) : string Parameters $status : int The meeting status; one of the Kronolith::STATUS_XXX constants. Return values string — The translated displayable meeting status string. subscribeRemoteCalendar() Kronolith.php : 1728 Subscribes to or updates a remote calendar. public static subscribeRemoteCalendar(array<string|int, mixed> &$info[, string $update = false ]) : mixed Parameters $info : array<string|int, mixed> Hash with calendar information. $update : string = false If present, the original URL of the calendar to update. Tags throws Kronolith_Exception Return values mixed — tabs() Kronolith.php : 2476 public static tabs(object $renderer) : mixed Parameters $renderer : object A Kronolith view. Return values mixed — toTimeslice() Kronolith.php : 3035 Exports an event to a timeslice. public static toTimeslice(Kronolith_Event $event, int $type, string $client) : mixed Parameters $event : Kronolith_Event An event. $type : int A job type ID. $client : string A client ID. Return values mixed — unsubscribeRemoteCalendar() Kronolith.php : 1770 Unsubscribes from a remote calendar. public static unsubscribeRemoteCalendar(string $url) : array<string|int, mixed> Parameters $url : string The calendar URL. Tags throws Kronolith_Exception Return values array<string|int, mixed> — Hash with the deleted calendar's information. updateShare() Kronolith.php : 1347 Updates an existing share. public static updateShare(mixed &$calendar, array<string|int, mixed> $info) : mixed Parameters $calendar : mixed $info : array<string|int, mixed> Hash with calendar information. Tags throws Kronolith_Exception Return values mixed — validateUserAttendee() Kronolith.php : 825 Return Kronolith_Attendee object for a local user. public static validateUserAttendee(string $user) : mixed Parameters $user : string The local username. Return values mixed — Return the Kronolith_Attendee object for $user, or false if the auth backend supports user listing and the user is not found. viewShowLocation() Kronolith.php : 2788 Should we show event location, based on the show_location pref? public static viewShowLocation() : mixed Return values mixed — viewShowTime() Kronolith.php : 2797 Should we show event time, based on the show_time preference? public static viewShowTime() : mixed Return values mixed — _sortEventStartTime() Kronolith.php : 2903 Used with usort() to sort events based on their start times. protected static _sortEventStartTime(mixed $a, mixed $b) : mixed Parameters $a : mixed $b : mixed Return values mixed — Search results