Method | Description | |
---|---|---|
_notificationPref ( string $user, string $mode, string $calendar = null ) : mixed | Returns whether a user wants email notifications for a calendar. | |
addCalendarLinks ( ) | Adds tags for calendar feeds to the HTML header. | |
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. | |
addEvents ( &$results, &$event, $startDate, $endDate, $showRecurrence, $json, $coverDates = true ) | Calculates recurrences of an event during a certain period. | |
addSearchEvents ( array &$events, Kronolith_Event $event, stdClass $query, boolean $json ) | Adds an event to set of search results. | |
addShare ( array $info ) : Horde_Share | Creates a new share. | |
attendeeList ( ) : string | Returns a comma separated list of attendees and resources | |
backgroundColor ( array | Horde_Share_Object $calendar ) : string | Returns the background color for a calendar. | |
buildMimeMessage ( Horde_View $view, string $template, Horde_Mime_Part $image ) : Horde_Mime_Part | Builds the body MIME part of a multipart message. | |
buildStatusWidget ( string $name, string $current = self::STATUS_CONFIRMED, string $any = false ) : string | Builds the HTML for an event status widget. | |
countEvents ( ) : integer | Returns the number of events in calendars that the current user owns. | |
currentDate ( ) : Horde_Date | ||
deleteShare ( Horde_Share $calendar ) | Deletes a share and removes all events associated with it. | |
displayedCalendars ( ) : array | Returns a list of currently displayed calendars. | |
embedCode ( string $calendar ) : string | Returs the HTML/javascript snippit needed to embed a calendar in an external website. | |
eventTabs ( string $tabname, Kronolith_Event $event ) | ||
feedUrl ( string $calendar ) : string | Returns the feed URL for a calendar. | |
foregroundColor ( array | Horde_Share_Object | string $calendar ) : string | Returns the foreground color for a calendar or a background color. | |
getAddressbookSearchParams ( ) : array | Determines parameters needed to do an address search | |
getCSSColors ( array | Horde_Share_Object $calendar, boolean $with_attribute = true ) : string | Returns the CSS color definition for a calendar. | |
getCalendar ( Kronolith_Driver $driver ) : Kronolith_Calendar | Returns a Kronolith_Calendar object for a driver instance. | |
getDefaultCalendar ( integer $permission = Horde_Perms::SHOW, boolean $owner_only = false ) : string | Returns the default calendar for the current user at the specified permissions level. | |
getDriver ( string $driver = null, string $calendar = null ) : Kronolith_Driver | Attempts to return a single, concrete Kronolith_Driver instance based on a driver name. | |
getImagePart ( string $file ) : Horde_Mime_Part | Returns a MIME part for an image to be embedded into a HTML document. | |
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. | |
getLabel ( $calendar ) : string | Returns the label to be used for a calendar. | |
getRemoteParams ( $calendar ) | Check for HTTP authentication credentials | |
getSyncCalendars ( boolean $prune = false ) : array | Returns the calendars that should be used for syncing. | |
getTagger ( ) : Kronolith_Tagger | Obtain a Kronolith_Tagger instance | |
getUserEmail ( $uid ) | Returns the email address, if available, of a user. | |
getUserName ( $uid ) | Returns the real name, if available, of a user. | |
getView ( string $view ) | Get a named Kronolith_View_* object and load it with the appropriate date parameters. | |
hasApiPermission ( string $api, integer $perm = Horde_Perms::READ ) : boolean | Checks whether an API (application) exists and the user has permission to access it. | |
hasPermission ( string $calendar, integer $perm ) : boolean | Returns whether the current user has certain permissions on a calendar. | |
initialize ( ) | Initial app setup code. | |
isUserEmail ( string $uid, string $email ) | Checks if an email address belongs to a user. | |
listAlarms ( Horde_Date $date, array $calendars, boolean $fullevent = false ) : array | Returns all the alarms active on a specific date. | |
listCalendars ( integer $permission = Horde_Perms::SHOW, boolean $display = false ) : array | Returns all calendars a user has access to, according to several parameters/permission levels. | |
listEvents ( Horde_Date $startDate, Horde_Date $endDate, array $calendars = null, array $options = [] ) : array | Returns all the events that happen each day within a time period | |
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. | |
listShareUsers ( Horde_Share_Object $share ) : array | Returns a list of user with read access to a share. | |
mergeEvents ( array &$results, array $events ) | Merges results from two listEvents() result sets. | |
notifyOfResourceRejection ( Kronolith_Event $event ) | Check for resource declines and push notice to stack if found. | |
parseDate ( string $date, boolean $withtime = true, $timezone = null ) : Horde_Date | Parses a complete date-time string into a Horde_Date object. | |
partToString ( integer $part ) : string | Maps a Kronolith attendee participation string to a translated string suitable for display. | |
permissionToJson ( Horde_Perms_Permission $perm, boolean $systemShare = false ) : array | Converts a permission object to a json object. | |
quickAdd ( string $text, string $calendar = null ) : array | Imports an event parsed from a string. | |
randomColor ( ) : string | Returns a random CSS color. | |
readPermsForm ( Horde_Share_Object | Kronolith_Resource_Base $share ) : array | Reads a submitted permissions form and updates the share permissions. | |
recurToString ( integer $type ) : string | Maps a Kronolith recurrence value to a translated string suitable for display. | |
removeUserEvents ( string $user ) | Remove all events owned by the specified user in all calendars. | |
responseFromICal ( string $response ) : string | Maps an iCalendar attendee response string to the corresponding Kronolith value. | |
responseToString ( integer $response ) : string | Maps a Kronolith attendee response string to a translated string suitable for display. | |
search ( object $query, string $calendar = null ) : array | Searches for events with the given properties. | |
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. | |
sendNotification ( Kronolith_Event $event, string $action ) | Sends email notifications that a event has been added, edited, or deleted to users that want such notifications. | |
showAjaxView ( ) | Returns whether to display the ajax view. | |
sortEvents ( array $days ) : array | Sorts an event list. | |
statusToString ( integer $status ) : string | Maps a Kronolith meeting status string to a translated string suitable for display. | |
subscribeRemoteCalendar ( array &$info, string $update = false ) | Subscribes to or updates a remote calendar. | |
tabs ( object $renderer ) | ||
toTimeslice ( Kronolith_Event $event, $type, $client ) | Export an event to a timeslice. | |
unsubscribeRemoteCalendar ( string $url ) : array | Unsubscribes from a remote calendar. | |
updateShare ( &$calendar, array $info ) | Updates an existing share. | |
validateUserAttendee ( string $user ) : mixed | Return Kronolith_Attendee object for a local user. | |
viewShowLocation ( ) | Should we show event location, based on the show_location pref? | |
viewShowTime ( ) | Should we show event time, based on the show_time preference? |
Method | Description | |
---|---|---|
_sortEventStartTime ( $a, $b ) | Used with usort() to sort events based on their start times. |
public static _notificationPref ( string $user, string $mode, string $calendar = null ) : mixed | ||
$user | string | A user name. |
$mode | string | 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. |
$calendar | string | The name of the calendar if mode is "read". |
return | mixed | The user's email, time, and language preferences if they want a notification for this calendar. |
protected static _sortEventStartTime ( $a, $b ) |
public static addCalendarLinks ( ) |
public static 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 ) | ||
$event | Kronolith_Event | An event object. |
$eventStart | Horde_Date | The event's start of the actual recurrence. |
$eventEnd | Horde_Date | The event's end of the actual recurrence. |
$json | boolean | Store the results of the events' toJson() method? |
$originalStart | Horde_Date | The actual starting time of a single event spanning multiple days. |
$originalEnd | Horde_Date | The actual ending time of a single event spanning multiple days. |
$endDate | Horde_Date |
public static addEvents ( &$results, &$event, $startDate, $endDate, $showRecurrence, $json, $coverDates = true ) |
public static addSearchEvents ( array &$events, Kronolith_Event $event, stdClass $query, boolean $json ) | ||
$events | array | The list of events to update with the new event. |
$event | Kronolith_Event | An event from a search result. |
$query | stdClass | A search query. |
$json | boolean | Store the results of the events' toJson() method? |
public static attendeeList ( ) : string | ||
return | string | Attendee/Resource list. |
public static backgroundColor ( array | Horde_Share_Object $calendar ) : string | ||
$calendar | array | Horde_Share_Object | A calendar share or a hash from a remote calender definition. |
return | string | A HTML color code. |
public static buildMimeMessage ( Horde_View $view, string $template, Horde_Mime_Part $image ) : Horde_Mime_Part | ||
$view | Horde_View | A view to render the HTML and plain text templates for the messate. |
$template | string | The template base name for the view. |
$image | Horde_Mime_Part | The MIME part of a related image. |
return | Horde_Mime_Part | A multipart/alternative MIME part. |
public static countEvents ( ) : integer | ||
return | integer | The number of events. |
public static displayedCalendars ( ) : array | ||
return | array | Currently displayed calendars. |
public static getAddressbookSearchParams ( ) : array | ||
return | array | An array with two keys: 'fields' and 'sources'. |
public static getCSSColors ( array | Horde_Share_Object $calendar, boolean $with_attribute = true ) : string | ||
$calendar | array | Horde_Share_Object | A calendar share or a hash from a remote calender definition. |
$with_attribute | boolean | Whether to wrap the colors inside a "style" attribute. |
return | string | A CSS string with color definitions. |
public static getCalendar ( Kronolith_Driver $driver ) : Kronolith_Calendar | ||
$driver | Kronolith_Driver | |
return | Kronolith_Calendar | The matching calendar instance. |
public static getDriver ( string $driver = null, string $calendar = null ) : Kronolith_Driver | ||
$driver | string | The type of concrete Kronolith_Driver subclass to return. |
$calendar | string | The calendar name. The format depends on the driver being used. |
return | Kronolith_Driver | The newly created concrete Kronolith_Driver instance. |
public static getImagePart ( string $file ) : Horde_Mime_Part | ||
$file | string | An image file name. |
return | Horde_Mime_Part | A MIME part representing the image. |
public static getInternalCalendar ( string $target ) : Kronolith_Resource | Horde_Share_Object | ||
$target | string | The calendar id to retrieve. |
return | Kronolith_Resource | Horde_Share_Object |
public static getRemoteParams ( $calendar ) |
public static getSyncCalendars ( boolean $prune = false ) : array | ||
$prune | boolean | 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 | array | An array of calendar ids |
public static getTagger ( ) : Kronolith_Tagger | ||
return | Kronolith_Tagger |
public static getUserEmail ( $uid ) |
public static getUserName ( $uid ) |
public static isUserEmail ( string $uid, string $email ) | ||
$uid | string | user id to check |
string | email address to check |
public static listAlarms ( Horde_Date $date, array $calendars, boolean $fullevent = false ) : array | ||
$date | Horde_Date | The date to check for alarms. |
$calendars | array | The calendars to check for events. |
$fullevent | boolean | Whether to return complete alarm objects or only alarm IDs. |
return | array | The alarms active on the date. A hash with calendar names as keys and arrays of events or event ids as values. |
public static listCalendars ( integer $permission = Horde_Perms::SHOW, boolean $display = false ) : array | ||
$permission | integer | The permission to filter calendars by. |
$display | boolean | Only return calendars that are supposed to be displayed per configuration and user preference. |
return | array | The calendar list. |
public static listEvents ( Horde_Date $startDate, Horde_Date $endDate, array $calendars = null, array $options = [] ) : array | ||
$startDate | Horde_Date | The start of the time range. |
$endDate | Horde_Date | The end of the time range. |
$calendars | array | The calendars to check for events. |
$options | 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) |
return | array | The events happening in this time period. |
public static listInternalCalendars ( boolean $owneronly = false, integer $permission = Horde_Perms::SHOW, string $user = null ) : array | ||
$owneronly | boolean | Only return calenders that this user owns? Defaults to false. |
$permission | integer | The permission to filter calendars by. |
$user | string | The user to list calendars for, if not the current. |
return | array | The calendar list. |
public static mergeEvents ( array &$results, array $events ) | ||
$results | array | First list of events. |
$events | array | List of events to be merged into the first one. |
public static notifyOfResourceRejection ( Kronolith_Event $event ) | ||
$event | Kronolith_Event |
public static partToString ( integer $part ) : string | ||
$part | integer | The attendee participation; one of the Kronolith::PART_XXX constants. |
return | string | The translated displayable attendee participation string. |
public static permissionToJson ( Horde_Perms_Permission $perm, boolean $systemShare = false ) : array | ||
$perm | Horde_Perms_Permission | A permission object. |
$systemShare | boolean | Is this from a system share? |
return | array | A hash suitable for json. |
public static randomColor ( ) : string | ||
return | string | A random CSS color string. |
public static readPermsForm ( Horde_Share_Object | Kronolith_Resource_Base $share ) : array | ||
$share | Horde_Share_Object | Kronolith_Resource_Base | The share to update. |
return | array | A list of error messages. |
public static recurToString ( integer $type ) : string | ||
$type | integer | The recurrence value; one of the Horde_Date_Recurrence::RECUR_XXX constants. |
return | string | The translated displayable recurrence value string. |
public static removeUserEvents ( string $user ) | ||
$user | string | The user name to delete events for. |
public static responseFromICal ( string $response ) : string | ||
$response | string | The attendee response. |
return | string | The Kronolith response value. |
public static responseToString ( integer $response ) : string | ||
$response | integer | The attendee response; one of the Kronolith::RESPONSE_XXX constants. |
return | string | The translated displayable attendee response string. |
public static sendITipNotifications ( Kronolith_Event $event, Horde_Notification_Handler $notification, integer $action, Horde_Date $instance = null, string $range = null, Kronolith_Attendee_List $cancellations = null ) | ||
$event | Kronolith_Event | The event in question. |
$notification | Horde_Notification_Handler | A notification object used to show result status. |
$action | integer | The type of notification to send. One of the Kronolith::ITIP_* values. |
$instance | Horde_Date | If cancelling a single instance of a recurring event, the date of this instance. |
$range | string | The range parameter if this is a recurring event. Possible values are self::RANGE_THISANDFUTURE |
$cancellations | Kronolith_Attendee_List | 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 |
public static sendNotification ( Kronolith_Event $event, string $action ) | ||
$event | Kronolith_Event | An event. |
$action | string | The event action. One of "add", "edit", or "delete". |
public static showAjaxView ( ) |
public static sortEvents ( array $days ) : array | ||
$days | array | A list of days with events. |
return | array | The sorted day list. |
public static statusToString ( integer $status ) : string | ||
$status | integer | The meeting status; one of the Kronolith::STATUS_XXX constants. |
return | string | The translated displayable meeting status string. |
public static subscribeRemoteCalendar ( array &$info, string $update = false ) | ||
$info | array | Hash with calendar information. |
$update | string | If present, the original URL of the calendar to update. |
public static toTimeslice ( Kronolith_Event $event, $type, $client ) | ||
$event | Kronolith_Event |
public static unsubscribeRemoteCalendar ( string $url ) : array | ||
$url | string | The calendar URL. |
return | array | Hash with the deleted calendar's information. |
public static validateUserAttendee ( string $user ) : mixed | ||
$user | string | The local username. |
return | mixed | Return the Kronolith_Attendee object for $user, or false if the auth backend supports user listing and the user is not found. |
public static viewShowLocation ( ) |
public static viewShowTime ( ) |