API Documentation
\

\Horde_Itip_Event_Vevent

A wrapper for vEvent iCalender data.

Copyright 2002-2017 Horde LLC (http://www.horde.org/) Copyright 2004-2010 Klarälvdalens Datakonsult AB

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see LGPL.

Summary

Methods
Properties
Constants
__construct()
getVevent()
getMethod()
getUid()
getSummary()
getStart()
getEnd()
getOrganizer()
copyEventInto()
setAttendee()
getStartParameters()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
setUid()
copyUid()
setSummary()
copySummary()
getDescription()
setDescription()
copyDescription()
setStart()
copyStart()
getEndParameters()
setEnd()
getDuration()
getDurationParameters()
setDuration()
copyEndOrDuration()
getSequence()
setSequence()
copySequence()
getLocation()
setLocation()
copyLocation()
getRawOrganizer()
getOrganizerParameters()
setOrganizer()
copyOrganizer()
$_vevent
N/A

Properties

$_vevent

$_vevent : \Horde_Icalendar_Vevent

The wrapped vEvent.

Type

\Horde_Icalendar_Vevent

Methods

__construct()

__construct(\Horde_Icalendar_Vevent  $vevent)

Constructor.

Parameters

\Horde_Icalendar_Vevent $vevent

The iCalendar object that will be wrapped by this instance.

getVevent()

getVevent() : \Horde_Icalendar_Vevent

Returns the wrapped vEvent.

Returns

\Horde_Icalendar_Vevent —

The wrapped event.

getMethod()

getMethod() : string

Return the method of the iTip request.

Returns

string —

The method of the request.

getUid()

getUid() : string

Return the uid of the iTip event.

Returns

string —

The uid of the event.

getSummary()

getSummary() : string

Return the summary for the event.

Returns

string —

The summary.

getStart()

getStart() : string

Return the start of the iTip event.

Returns

string —

The start of the event.

getEnd()

getEnd() : string

Return the end of the iTip event.

Returns

string —

The end of the event.

getOrganizer()

getOrganizer() : string

Return the organizer of the iTip event.

Returns

string —

The organizer of the event.

copyEventInto()

copyEventInto(\Horde_Itip_Event  $event) : NULL

Copy the details from an event into this one.

Parameters

\Horde_Itip_Event $event

The event to copy from.

Returns

NULL

setAttendee()

setAttendee(string  $attendee, string  $common_name, string  $status) : NULL

Set the attendee parameters.

Parameters

string $attendee

The mail address of the attendee.
string $common_name

Common name of the attendee.
string $status

Attendee status (ACCPETED, DECLINED, TENTATIVE)

Returns

NULL

getStartParameters()

getStartParameters() : array

Return the start parameters of the iTip event.

Returns

array —

The start parameters of the event.

setUid()

setUid(string  $uid) : NULL

Set the uid of the iTip event.

Parameters

string $uid

The uid of the event.

Returns

NULL

copyUid()

copyUid(\Horde_Itip_Event  $itip) : NULL

Copy the uid from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

setSummary()

setSummary(string  $summary) : NULL

Set the summary for the event.

Parameters

string $summary

The summary.

Returns

NULL

copySummary()

copySummary(\Horde_Itip_Event  $itip) : NULL

Copy the summary from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

getDescription()

getDescription() : string

Return the description for the event.

Returns

string —

The description.

setDescription()

setDescription(string  $description) : NULL

Set the description for the event.

Parameters

string $description

The description.

Returns

NULL

copyDescription()

copyDescription(\Horde_Itip_Event  $itip) : NULL

Copy the description from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

setStart()

setStart(string  $start, array  $parameters) : NULL

Set the start of the iTip event.

Parameters

string $start

The start of the event.
array $parameters

Additional parameters.

Returns

NULL

copyStart()

copyStart(\Horde_Itip_Event  $itip) : NULL

Copy the start time from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

getEndParameters()

getEndParameters() : array

Return the end parameters of the iTip event.

Returns

array —

The end parameters of the event.

setEnd()

setEnd(string  $end, array  $parameters) : NULL

Set the end of the iTip event.

Parameters

string $end

The end of the event.
array $parameters

Additional parameters.

Returns

NULL

getDuration()

getDuration() : string

Return the duration for the event.

Returns

string —

The duration of the event.

getDurationParameters()

getDurationParameters() : array

Return the duration parameters of the iTip event.

Returns

array —

The duration parameters of the event.

setDuration()

setDuration(string  $duration, array  $parameters) : NULL

Set the duration of the iTip event.

Parameters

string $duration

The duration of the event.
array $parameters

Additional parameters.

Returns

NULL

copyEndOrDuration()

copyEndOrDuration(\Horde_Itip_Event  $itip) : NULL

Copy the end time or event duration from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

getSequence()

getSequence() : string

Return the sequence for the event.

Returns

string —

The sequence.

setSequence()

setSequence(string  $sequence) : NULL

Set the sequence for the event.

Parameters

string $sequence

The sequence.

Returns

NULL

copySequence()

copySequence(\Horde_Itip_Event  $itip) : NULL

Copy the sequence from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

getLocation()

getLocation() : string

Return the location for the event.

Returns

string —

The location.

setLocation()

setLocation(string  $location) : NULL

Set the location for the event.

Parameters

string $location

The location.

Returns

NULL

copyLocation()

copyLocation(\Horde_Itip_Event  $itip) : NULL

Copy the location from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL

getRawOrganizer()

getRawOrganizer() : string

Return the organizer for the event.

Returns

string —

The organizer of the event.

getOrganizerParameters()

getOrganizerParameters() : array

Return the organizer parameters of the iTip event.

Returns

array —

The organizer parameters of the event.

setOrganizer()

setOrganizer(string  $organizer, array  $parameters) : NULL

Set the organizer of the iTip event.

Parameters

string $organizer

The organizer of the event.
array $parameters

Additional parameters.

Returns

NULL

copyOrganizer()

copyOrganizer(\Horde_Itip_Event  $itip) : NULL

Copy the organizer from the request into the provided iTip instance.

Parameters

\Horde_Itip_Event $itip

Returns

NULL