Horde_Itip_Event_Vevent
in package
implements
Horde_Itip_Event
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.
Tags
Interfaces, Classes, Traits and Enums
- Horde_Itip_Event
- Defines the event interface required for iTip-Handling / resource booking.
Table of Contents
- $_vevent : Horde_Icalendar_Vevent
- The wrapped vEvent.
- __construct() : mixed
- Constructor.
- copyEventInto() : null
- Copy the details from an event into this one.
- getEnd() : string
- Return the end of the iTip event.
- getMethod() : string
- Return the method of the iTip request.
- getOrganizer() : string
- Return the organizer of the iTip event.
- getStart() : string
- Return the start of the iTip event.
- getStartParameters() : array<string|int, mixed>
- Return the start parameters of the iTip event.
- getSummary() : string
- Return the summary for the event.
- getUid() : string
- Return the uid of the iTip event.
- getVevent() : Horde_Icalendar_Vevent
- Returns the wrapped vEvent.
- setAttendee() : null
- Set the attendee parameters.
- copyDescription() : null
- Copy the description from the request into the provided iTip instance.
- copyEndOrDuration() : null
- Copy the end time or event duration from the request into the provided iTip instance.
- copyLocation() : null
- Copy the location from the request into the provided iTip instance.
- copyOrganizer() : null
- Copy the organizer from the request into the provided iTip instance.
- copySequence() : null
- Copy the sequence from the request into the provided iTip instance.
- copyStart() : null
- Copy the start time from the request into the provided iTip instance.
- copySummary() : null
- Copy the summary from the request into the provided iTip instance.
- copyUid() : null
- Copy the uid from the request into the provided iTip instance.
- getDescription() : string
- Return the description for the event.
- getDuration() : string
- Return the duration for the event.
- getDurationParameters() : array<string|int, mixed>
- Return the duration parameters of the iTip event.
- getEndParameters() : array<string|int, mixed>
- Return the end parameters of the iTip event.
- getLocation() : string
- Return the location for the event.
- getOrganizerParameters() : array<string|int, mixed>
- Return the organizer parameters of the iTip event.
- getRawOrganizer() : string
- Return the organizer for the event.
- getSequence() : string
- Return the sequence for the event.
- setDescription() : null
- Set the description for the event.
- setDuration() : null
- Set the duration of the iTip event.
- setEnd() : null
- Set the end of the iTip event.
- setLocation() : null
- Set the location for the event.
- setOrganizer() : null
- Set the organizer of the iTip event.
- setSequence() : null
- Set the sequence for the event.
- setStart() : null
- Set the start of the iTip event.
- setSummary() : null
- Set the summary for the event.
- setUid() : null
- Set the uid of the iTip event.
Properties
$_vevent
The wrapped vEvent.
private
Horde_Icalendar_Vevent
$_vevent
Methods
__construct()
Constructor.
public
__construct(Horde_Icalendar_Vevent $vevent) : mixed
Parameters
- $vevent : Horde_Icalendar_Vevent
-
The iCalendar object that will be wrapped by this instance.
Return values
mixed —copyEventInto()
Copy the details from an event into this one.
public
copyEventInto(Horde_Itip_Event $event) : null
Parameters
- $event : Horde_Itip_Event
-
The event to copy from.
Return values
null —getEnd()
Return the end of the iTip event.
public
getEnd() : string
Return values
string —The end of the event.
getMethod()
Return the method of the iTip request.
public
getMethod() : string
Return values
string —The method of the request.
getOrganizer()
Return the organizer of the iTip event.
public
getOrganizer() : string
Tags
Return values
string —The organizer of the event.
getStart()
Return the start of the iTip event.
public
getStart() : string
Return values
string —The start of the event.
getStartParameters()
Return the start parameters of the iTip event.
public
getStartParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —The start parameters of the event.
getSummary()
Return the summary for the event.
public
getSummary() : string
Return values
string —The summary.
getUid()
Return the uid of the iTip event.
public
getUid() : string
Return values
string —The uid of the event.
getVevent()
Returns the wrapped vEvent.
public
getVevent() : Horde_Icalendar_Vevent
Return values
Horde_Icalendar_Vevent —The wrapped event.
setAttendee()
Set the attendee parameters.
public
setAttendee(string $attendee, string $common_name, string $status) : null
Parameters
- $attendee : string
-
The mail address of the attendee.
- $common_name : string
-
Common name of the attendee.
- $status : string
-
Attendee status (ACCPETED, DECLINED, TENTATIVE)
Return values
null —copyDescription()
Copy the description from the request into the provided iTip instance.
private
copyDescription(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copyEndOrDuration()
Copy the end time or event duration from the request into the provided iTip instance.
private
copyEndOrDuration(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copyLocation()
Copy the location from the request into the provided iTip instance.
private
copyLocation(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copyOrganizer()
Copy the organizer from the request into the provided iTip instance.
private
copyOrganizer(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copySequence()
Copy the sequence from the request into the provided iTip instance.
private
copySequence(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copyStart()
Copy the start time from the request into the provided iTip instance.
private
copyStart(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copySummary()
Copy the summary from the request into the provided iTip instance.
private
copySummary(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —copyUid()
Copy the uid from the request into the provided iTip instance.
private
copyUid(Horde_Itip_Event $itip) : null
Parameters
- $itip : Horde_Itip_Event
Return values
null —getDescription()
Return the description for the event.
private
getDescription() : string
Return values
string —The description.
getDuration()
Return the duration for the event.
private
getDuration() : string
Return values
string —The duration of the event.
getDurationParameters()
Return the duration parameters of the iTip event.
private
getDurationParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —The duration parameters of the event.
getEndParameters()
Return the end parameters of the iTip event.
private
getEndParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —The end parameters of the event.
getLocation()
Return the location for the event.
private
getLocation() : string
Return values
string —The location.
getOrganizerParameters()
Return the organizer parameters of the iTip event.
private
getOrganizerParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —The organizer parameters of the event.
getRawOrganizer()
Return the organizer for the event.
private
getRawOrganizer() : string
Return values
string —The organizer of the event.
getSequence()
Return the sequence for the event.
private
getSequence() : string
Return values
string —The sequence.
setDescription()
Set the description for the event.
private
setDescription(string $description) : null
Parameters
- $description : string
-
The description.
Return values
null —setDuration()
Set the duration of the iTip event.
private
setDuration(string $duration, array<string|int, mixed> $parameters) : null
Parameters
- $duration : string
-
The duration of the event.
- $parameters : array<string|int, mixed>
-
Additional parameters.
Return values
null —setEnd()
Set the end of the iTip event.
private
setEnd(string $end, array<string|int, mixed> $parameters) : null
Parameters
- $end : string
-
The end of the event.
- $parameters : array<string|int, mixed>
-
Additional parameters.
Return values
null —setLocation()
Set the location for the event.
private
setLocation(string $location) : null
Parameters
- $location : string
-
The location.
Return values
null —setOrganizer()
Set the organizer of the iTip event.
private
setOrganizer(string $organizer, array<string|int, mixed> $parameters) : null
Parameters
- $organizer : string
-
The organizer of the event.
- $parameters : array<string|int, mixed>
-
Additional parameters.
Return values
null —setSequence()
Set the sequence for the event.
private
setSequence(string $sequence) : null
Parameters
- $sequence : string
-
The sequence.
Return values
null —setStart()
Set the start of the iTip event.
private
setStart(string $start, array<string|int, mixed> $parameters) : null
Parameters
- $start : string
-
The start of the event.
- $parameters : array<string|int, mixed>
-
Additional parameters.
Return values
null —setSummary()
Set the summary for the event.
private
setSummary(string $summary) : null
Parameters
- $summary : string
-
The summary.
Return values
null —setUid()
Set the uid of the iTip event.
private
setUid(string $uid) : null
Parameters
- $uid : string
-
The uid of the event.