Documentation

Kronolith_Event_Horde extends Kronolith_Event
in package

Kronolith

See the enclosed file LICENSE for license information (GPL). If you did not receive this file, see http://www.horde.org/licenses/gpl.

$alarm

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


    public
        int
    $alarm
     = 0

$allday

Whether this is an all-day event.


    public
        bool
    $allday
     = alse

$attendees

All the attendees of this event.


    public
        Kronolith_Attendee_List
    $attendees

$baseid

The baseid. For events that represent exceptions this is the UID of the original, recurring event.


    public
        string
    $baseid

$calendar

The identifier of the calender this event exists on.


    public
        string
    $calendar

$calendarType

The type of the calender this event exists on.


    public
        string
    $calendarType
     = 'external'

$created

The creation time.


    public
        Horde_Date
    $created

$createdby

The creator string.


    public
        string
    $createdby

$creator


    public
        string|null
    $creator

$description

The description for this event.


    public
        string
    $description
     = ''

$durMin

The duration of this event in minutes


    public
        int
    $durMin
     = 0

$end

The end time of the event.


    public
        Horde_Date
    $end

$exceptionoriginaldate

For exceptions, the date of the original recurring event that this is an exception for.


    public
        Horde_Date
    $exceptionoriginaldate

$first

Whether this is the event on the first day of a multi-day event.


    public
        boolen
    $first
     = 	rue

$geoLocation


    public
        array<string|int, mixed>
    $geoLocation

$icon

URL to an icon of this event.


    public
        string
    $icon
     = ''

$id


    public
        string|null
    $id

$indent


    public
        int
    $indent

$initialized

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


    public
        bool
    $initialized
     = alse

$last

Whether this is the event on the last day of a multi-day event.


    public
        boolen
    $last
     = 	rue

$location

The location this event occurs at.


    public
        string
    $location
     = ''

$methods

The particular alarm methods overridden for this event.


    public
        array<string|int, mixed>
    $methods

$modified

The last modification time.


    public
        Horde_Date
    $modified

$modifiedby

The last-modifier string.


    public
        string
    $modifiedby

$organizer

The email address of the organizer of the event, if known.


    public
        string
    $organizer
     = 
ull

$originalEnd


    public
        Horde_Date
    $originalEnd

$originalStart


    public
        Horde_Date
    $originalStart

$overlap


    public
        int
    $overlap

$private

Whether the event is private.


    public
        bool
    $private
     = alse

$recurrence

The Horde_Date_Recurrence class for this event.


    public
        Horde_Date_Recurrence
    $recurrence

$recurrenceid

The iCalendar RECURRENCE-ID for this event exception.


    public
        int
    $recurrenceid
     = 
ull

$rowspan


    public
        int
    $rowspan

$sequence

The iCalendar SEQUENCE for this event.


    public
        int
    $sequence
     = 
ull

$span


    public
        int
    $span

$start

The start time of the event.


    public
        Horde_Date
    $start

$status

The status of this event.


    public
        int
    $status
     = Kronolith::STATUS_CONFIRMED

$stored

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


    public
        bool
    $stored
     = alse

$tags


    public
        array<string|int, mixed>|string|null
    $tags

$timezone

The timezone of this event.


    public
        string
    $timezone

$title

The title of this event.


    public
        string
    $title
     = ''

For displaying in the interface use getTitle() instead.

$uid

The UID for this event.


    public
        string
    $uid
     = 
ull

$url

URL of this event.


    public
        string
    $url
     = ''

$_ajaxLink

The link to this event in the ajax interface.


    protected
        string
    $_ajaxLink

$_api

The API (application) of this event.


    protected
        string
    $_api

$_backgroundColor

The HTML background color to be used for this event.


    protected
        string
    $_backgroundColor
     = '#dddddd'

$_creator

The user id of the creator of the event.


    protected
        string
    $_creator
     = 
ull

$_deleteLink

The link to delete this event.


    protected
        string
    $_deleteLink

$_duration

The cached event duration, split up in time units.


    protected
        stdClass
    $_duration

$_editLink

The link to edit this event.


    protected
        string
    $_editLink

$_foregroundColor

The HTML foreground color to be used for this event.


    protected
        string
    $_foregroundColor
     = '#000000'

$_geoLocation

Geolocation


    protected
        array<string|int, mixed>
    $_geoLocation

$_id

The driver unique identifier for this event.


    protected
        string
    $_id
     = 
ull

$_indent

Used in view renderers.


    protected
        int
    $_indent

$_internaltags

Event tags from the storage backend (e.g. Kolab)


    protected
        array<string|int, mixed>
    $_internaltags

$_link

The link to this event.


    protected
        string
    $_link

$_originalEnd

The original end time of the event.


    protected
        Horde_Date
    $_originalEnd

$_originalStart

The original start time of the event.


    protected
        Horde_Date
    $_originalStart

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

Used in view renderers.


    protected
        int
    $_overlap

$_owner

The event's owner.


    protected
        string
    $_owner

$_params

Any parameters to identify the object in the other Horde application.


    protected
        array<string|int, mixed>
    $_params

$_permissions

A bitmask of permissions the current user has on this object.


    protected
        int
    $_permissions

$_resources

All resources of this event.


    protected
        array<string|int, mixed>
    $_resources
     = array()

This is an associative array where keys are resource uids, values are associative arrays with keys attendance and response.

$_rowspan

Used in view renderers.


    protected
        int
    $_rowspan

$_snooze

Snooze minutes for this event's alarm.


    protected
        int
    $_snooze

$_span

Used in view renderers.


    protected
        int
    $_span

$_tags

This tag's events.


    protected
        array<string|int, mixed>|string
    $_tags
     = 
ull

$_variableLength

Whether this event has a variable length.


    protected
        mixed
    $_variableLength

$_vfs

VFS handler


    protected
        Horde_Vfs
    $_vfs

$_varRenderer

The VarRenderer class to use for printing select elements.


    private
        Horde_Core_Ui_VarRenderer
    $_varRenderer

__construct()

Constructor.


    public
                __construct(Kronolith_Driver_Horde $driver[, mixed $eventObject = null ]) : mixed

Parameters

$driver : Kronolith_Driver_Horde: The backend driver that this event is stored in.
$eventObject : mixed = null: Backend specific event object that this will represent.

Return values

mixed —

__get()

Getter.


    public
                __get(string $name) : mixed

Returns the 'id' and 'creator' properties.

Parameters

$name : string: Property name.

Return values

mixed —

Property value.

__set()

Setter.


    public
                __set(string $name, mixed $value) : mixed

Sets the 'id' and 'creator' properties.

Parameters

$name : string: Property name.
$value : mixed: Property value.

Return values

mixed —

addAttendee()

Adds a new attendee to the current event.


    public
                addAttendee(string $email, int $role, int|bool $response[, string $name = null ]) : mixed

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

Parameters

$email : string: The email address of the attendee.
$role : int: The role code of the attendee.
$response : int|bool: The response code of the attendee.
$name : string = null: The name of the attendee.

Return values

mixed —

addEASFiles()


    public
                addEASFiles(mixed $message) : mixed

Parameters

$message : mixed

Return values

mixed —

addFile()

Saves a file into the VFS backend associated with this event.


    public
                addFile(array<string|int, mixed> $info) : mixed

Parameters

$info : array<string|int, mixed>: A hash with the file information as returned from a Horde_Form_Type_file.

Return values

mixed —

addFileFromData()

Saves a file into the VFS backend associated with this event.


    public
                addFileFromData(array<string|int, mixed> $info) : mixed

Parameters

$info : array<string|int, mixed>: A hash with the file information and the file contents in 'data'.

Return values

mixed —

addResource()

Adds a single resource to this event.


    public
                addResource(Kronolith_Resource $resource, mixed $response) : mixed

No validation or acceptence/denial is done here...it should be done when saving the event.

Parameters

$resource : Kronolith_Resource: The resource to add.
$response : mixed

Return values

mixed —

boundExceptions()

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.


    public
                boundExceptions([bool $flat = true ]) : array<string|int, mixed>

Parameters

$flat : bool = true: If true (the default), returns a flat array containing Kronolith_Event objects. If false, results are in the format of listEvents calls. @see Kronolith::listEvents().

Return values

array<string|int, mixed> —

An array of Kronolith_Event objects whose baseid property is equal to this event's uid. I.e., it is a bound exception.

deleteFile()

Deletes a file from the VFS backend associated with this event.


    public
                deleteFile(string $file) : mixed

Parameters

$file : string: The file name.

Return values

mixed —

deleteFiles()

Deletes all files from the VFS backend associated with this event.


    public
                deleteFiles() : mixed

Return values

mixed —

disconnectExceptions()

Disconnect any existing exceptions.


    public
                disconnectExceptions([bool $delete = false ]) : mixed

Parameters

$delete : bool = false: If true, disconnected exceptions will be deleted completely.

Return values

mixed —

exceptionLink()

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


    public
                exceptionLink(string $date) : string

Parameters

$date : string: Exception in the format Ymd.

Return values

string —

The formatted date and delete link.

exceptionsList()

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


    public
                exceptionsList() : string

Return values

string —

List of exception dates and delete links.

exists()

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


    public
                exists() : bool

Does the check based on the uid.

Return values

bool —

True if event exists, false otherwise.

fromASAppointment()

Imports the values for this event from a MS ActiveSync Message.


    public
                fromASAppointment(Horde_ActiveSync_Message_Appointment $message) : mixed

Parameters

$message : Horde_ActiveSync_Message_Appointment

Return values

mixed —

fromDriver()

Imports a backend specific event object.


    public
                fromDriver(mixed $event) : mixed

Parameters

$event : mixed: Backend specific event object that this object will represent.

Return values

mixed —

fromHash()

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


    public
                fromHash(array<string|int, mixed> $hash) : mixed

Parameters

$hash : array<string|int, mixed>: Array containing all the values.

Return values

mixed —

fromiCalendar()

Updates the properties of this event from a Horde_Icalendar_Vevent object.


    public
                fromiCalendar(Horde_Icalendar_Vevent $vEvent[, bool $parseAttendees = false ]) : mixed

Parameters

$vEvent : Horde_Icalendar_Vevent: The iCalendar data to update from.
$parseAttendees : bool = false: Parse attendees too? @since Kronolith 4.2

Return values

mixed —

getCSSColors()

Returns the CSS color definition for this event.


    public
                getCSSColors([bool $with_attribute = true ]) : string

Parameters

$with_attribute : bool = true: Whether to wrap the colors inside a "style" attribute.

Return values

string —

A CSS string with color definitions.

getDeleteUrl()


    public
                getDeleteUrl([array<string|int, mixed> $params = array() ][, mixed $full = false ]) : Horde_Url

Parameters

$params : array<string|int, mixed> = array()
$full : mixed = false

Return values

Horde_Url —

getDriver()

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


    public
                getDriver() : Kronolith_Driver

Return values

Kronolith_Driver —

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

getDuration()


    public
                getDuration() : mixed

Return values

mixed —

getEditUrl()


    public
                getEditUrl([array<string|int, mixed> $params = array() ][, mixed $full = false ]) : Horde_Url

Parameters

$params : array<string|int, mixed> = array()
$full : mixed = false

Return values

Horde_Url —

getExportUrl()


    public
                getExportUrl([array<string|int, mixed> $params = array() ][, mixed $full = false ]) : Horde_Url

Parameters

$params : array<string|int, mixed> = array()
$full : mixed = false

Return values

Horde_Url —

getLink()


    public
                getLink([mixed $datetime = null ][, mixed $icons = true ][, mixed $from_url = null ][, mixed $full = false ][, mixed $encoded = true ]) : mixed

Parameters

$datetime : mixed = null
$icons : mixed = true
$from_url : mixed = null
$full : mixed = false
$encoded : mixed = true

Return values

mixed —

getLocation()

Returns the location of this event, considering private flags.


    public
                getLocation([string $user = null ]) : string

Parameters

$user : string = null: The current user.

Return values

string —

The location of this event.

getRecurName()

Returns a description of this event's recurring type.


    public
                getRecurName() : string

Return values

string —

Human readable recurring type.

getResources()

Returns all resources.


    public
                getResources() : array<string|int, mixed>

Return values

array<string|int, mixed> —

A copy of the resources array.

getShare()

Returns the share this event belongs to.


    public
                getShare() : Horde_Share

Return values

Horde_Share —

This event's share.

getStatusClass()


    public
                getStatusClass() : string

Return values

string —

The CSS class for the event based on its status.

getTimeRange()


    public
                getTimeRange() : string

Return values

string —

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

getTitle()

Returns the title of this event.


    public
                getTitle([string $user = null ]) : string

Parameters

$user : string = null: The current user.

Return values

string —

The title of this event.

getTooltip()


    public
                getTooltip() : string

Return values

string —

A tooltip for quick descriptions of this event.

getVfsUid()

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.


    public
                getVfsUid() : string

Return values

string —

The unique id.

getViewUrl()


    public
                getViewUrl([array<string|int, mixed> $params = array() ][, mixed $full = false ][, mixed $encoded = true ]) : Horde_Url

Parameters

$params : array<string|int, mixed> = array()
$full : mixed = false
$encoded : mixed = true

Return values

Horde_Url —

hasAttendee()

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


    public
                hasAttendee(string $email[, bool $case_sensitive = false ][, array<string|int, mixed> $attendees = null ]) : bool

Parameters

$email : string: The email address of the attendee.
$case_sensitive : bool = false: Match in a case sensitive manner. @since 4.3.0
$attendees : array<string|int, mixed> = null: Search that attendee list instead of this event's. @since 4.3.0

Return values

bool —

True if the specified attendee is present for this event.

hasPermission()

Encapsulates permissions checking.


    public
                hasPermission(int $permission[, string $user = null ]) : bool

Parameters

$permission : int: The permission to check for.
$user : string = null: The user to check permissions for.

Return values

bool —

html()


    public
                html(mixed $property) : mixed

Parameters

$property : mixed

Return values

mixed —

isAllDay()


    public
                isAllDay() : mixed

Return values

mixed —

isPrivate()

Returns whether the event should be considered private.


    public
                isPrivate([string $user = null ]) : bool

Parameters

$user : string = null: The current user. If omitted, uses the current user.

Return values

bool —

Whether to consider the event as private.

listFiles()

Returns all files from the VFS backend associated with this event.


    public
                listFiles() : array<string|int, mixed>

Return values

array<string|int, mixed> —

A list of hashes with file informations.

loadHistory()

Retrieves history information for this event from the history backend.


    public
                loadHistory() : mixed

Return values

mixed —

readForm()

Reads form/post data and updates this event's properties.


    public
                readForm([Kronolith_Event|null $existing = null ]) : mixed

Parameters

$existing : Kronolith_Event|null = null: If this is an exception event this is taken as the base event. @since 4.2.6

Return values

mixed —

readRecurrenceForm()


    public
            static    readRecurrenceForm(mixed $start, mixed $timezone[, mixed $recurrence = null ]) : mixed

Parameters

$start : mixed
$timezone : mixed
$recurrence : mixed = null

Return values

mixed —

recurs()

Returns whether this event is a recurring event.


    public
                recurs() : bool

Return values

bool —

True if this is a recurring event.

removeResource()

Removes a resource from this event.


    public
                removeResource(Kronolith_Resource $resource) : mixed

Parameters

$resource : Kronolith_Resource: The resource to remove.

Return values

mixed —

save()

Saves changes to this event.


    public
                save() : int

Return values

int —

The event id.

setResources()

Set the entire resource array. Only used when copying an Event.


    public
                setResources(array<string|int, mixed> $resources) : mixed

Parameters

$resources : array<string|int, mixed>: The resource array.

Return values

mixed —

setTimezone()

Converts this event between the event's and the local timezone.


    public
                setTimezone(mixed $to_original) : mixed

Parameters

$to_original : mixed

Return values

mixed —

synchronizeTags()

Syncronizes tags from the tagging backend with the task storage backend, if necessary.


    public
                synchronizeTags(array<string|int, mixed> $tags) : mixed

Parameters

$tags : array<string|int, mixed>: Tags from the tagging backend.

Return values

mixed —

toAlarm()

Returns an alarm hash of this event suitable for Horde_Alarm.


    public
                toAlarm(Horde_Date $time[, string $user = null ][, Prefs $prefs = null ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed> —

Alarm hash or null.

toASAppointment()

Export this event as a MS ActiveSync Message


    public
                toASAppointment([array<string|int, mixed> $options = array() ]) : Horde_ActiveSync_Message_Appointment

Parameters

$options : array<string|int, mixed> = array()

Options:

protocolversion: (float) The EAS version to support DEFAULT: 2.5
bodyprefs: (array) A BODYPREFERENCE array. DEFAULT: none (No body prefs enforced).
truncation: (integer) Truncate event body to this length DEFAULT: none (No truncation).

Return values

Horde_ActiveSync_Message_Appointment —

toHash()

Exports the values for this event to an array of values.


    public
                toHash() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Array containing all the values.

toiCalendar()

Exports this event in iCalendar format.


    public
                toiCalendar(Horde_Icalendar $calendar[, bool $includeFiles = true ]) : array<string|int, mixed>

Parameters

$calendar : Horde_Icalendar: A Horde_Icalendar object that acts as a container.
$includeFiles : bool = true: Include attached files in the iCalendar file? @since 4.3.0

Return values

array<string|int, mixed> —

An array of Horde_Icalendar_Vevent objects for this event.

toJson()

Returns a simple object suitable for json transport representing this event.


    public
                toJson([array<string|int, mixed> $options = array() ]) : stdClass

Parameters

$options : array<string|int, mixed> = array()

An array of options:

all_day: (boolean) If not null, overrides whether the event is an all-day event. DEFAULT: null (Do not override).
full: (boolean) Whether to return all event details. DEFAULT: false (Do not return all details).
time_format: (string) The date() format to use for time formatting. DEFAULT: 'H:i'
history: (boolean) If true, ensures that this event's history is loaded from the History backend. DEFAULT: false (Do not ensure history is loaded).

Return values

stdClass —

A simple object.

toTimeobject()

Prepares this event to be saved to the backend.


    public
                toTimeobject() : mixed

Return values

mixed —

vfsDisplayUrl()

Returns a link to display and download a file from the VFS backend associated with this object.


    public
                vfsDisplayUrl(array<string|int, mixed> $file) : string

Parameters

$file : array<string|int, mixed>: The file information hash as returned from self::listFiles.

Return values

string —

The HTML code of the generated link.

vfsEditUrl()

Returns a link to display, download, and delete a file from the VFS backend associated with this object.


    public
                vfsEditUrl(array<string|int, mixed> $file) : string

Parameters

$file : array<string|int, mixed>: The file information hash as returned from self::listFiles.

Return values

string —

The HTML code of the generated link.

vfsInit()

Loads the VFS configuration and initializes the VFS backend.


    public
                vfsInit() : Horde_Vfs

Return values

Horde_Vfs —

A VFS object.

_addEASFile()


    protected
                _addEASFile(Horde_ActiveSync_Message_AirSyncBaseAdd $add) : mixed

Parameters

$add : Horde_ActiveSync_Message_AirSyncBaseAdd

Return values

mixed —

_addFile()

Saves a file into the VFS backend associated with this event.


    protected
                _addFile(array<string|int, mixed> $info[, bool $data = false ]) : mixed

Parameters

$info : array<string|int, mixed>: A hash with the file information.
$data : bool = false: Whether the file contents is in $info['data'].

Return values

mixed —

_ensureUtf8()

Ensure the given string is valid UTF-8.


    protected
                _ensureUtf8(string $text) : string|bool

Parameters

$text : string: The string to ensure contains no invalid UTF-8 sequences.

Return values

string|bool —

The valid UTF-8 string, possibly with illegal sequences removed.

_formIDEncode()


    protected
                _formIDEncode(mixed $id) : mixed

Parameters

$id : mixed

Return values

mixed —

_getEASFileReference()


    protected
                _getEASFileReference(mixed $filename) : mixed

Parameters

$filename : mixed

Return values

mixed —

_handleEas16Exception()

Handle adding/editing exceptions from EAS 16.0 clients.


    protected
                _handleEas16Exception(Horde_ActiveSync_Message_Appointment $message) : bool

Parameters

$message : Horde_ActiveSync_Message_Appointment

Return values

bool —

_handleResources()

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.


    protected
                _handleResources([Kronolith_Event|null $existing = null ]) : mixed

Parameters

$existing : Kronolith_Event|null = null: An existing base event.

Return values

mixed —

_handlevEventRecurrence()

Handle parsing recurrence related fields.


    protected
                _handlevEventRecurrence(Horde_Icalendar $vEvent) : mixed

Parameters

$vEvent : Horde_Icalendar

Return values

mixed —

Kronolith_Event_Horde extends Kronolith_Event in package Kronolith

Tags

Table of Contents

Properties

$alarm

$allday

$attendees

$baseid

$calendar

$calendarType

$created

Tags

$createdby

Tags

$creator

$description

$durMin

$end

$exceptionoriginaldate

$first

$geoLocation

$icon

$id

$indent

$initialized

$last

$location

$methods

$modified

Tags

$modifiedby

Tags

$organizer

$originalEnd

$originalStart

$overlap

$private

$recurrence

$recurrenceid

$rowspan

$sequence

$span

$start

$status

$stored

$tags

$timezone

$title

$uid

$url

$_ajaxLink

$_api

$_backgroundColor

$_creator

$_deleteLink

$_duration

Tags

$_editLink

$_foregroundColor

$_geoLocation

$_id

$_indent

$_internaltags

$_link

$_originalEnd

Tags

$_originalStart

$_overlap

$_owner

$_params

$_permissions

$_resources

$_rowspan

$_snooze

Tags

$_span

$_tags

$_variableLength

Tags

$_vfs

Kronolith_Event_Horde extends Kronolith_Event
in package

Kronolith