PHP Class Horde_Itip_Event_Vtodo, horde

Copyright 2002-2016 Horde LLC (http://www.horde.org/) Copyright 2004-2010 Klarälvdalens Datakonsult AB See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see {@link http://www.horde.org/licenses/lgpl21 LGPL}.
Author: Gunnar Wrobel ([email protected])
Author: Michael J Rubinsky ([email protected])
Inheritance: implements Horde_Itip_Event
显示文件 Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Horde_Icalendar_Vtodo $vevent ) Constructor.
copyEventInto ( Horde_Itip_Event $event ) : 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.
getPercentComplete ( ) : integer Return the PERCENT-COMPLETE attribute.
getStart ( ) : string Return the start of the iTip event.
getStartParameters ( ) : array 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_Vtodo Returns the wrapped vTodo.
setAttendee ( string $attendee, string $common_name, string $status ) : null Set the attendee parameters.

Private Methods

Method Description
copyDescription ( Horde_Itip_Event $itip ) : null Copy the description from the request into the provided iTip instance.
copyLocation ( Horde_Itip_Event $itip ) : null Copy the location from the request into the provided iTip instance.
copyOrganizer ( Horde_Itip_Event $itip ) : null Copy the organizer from the request into the provided iTip instance.
copyPercentComplete ( Horde_Itip_Event $itip )
copySequence ( Horde_Itip_Event $itip ) : null Copy the sequence from the request into the provided iTip instance.
copyStart ( Horde_Itip_Event $itip ) : null Copy the start time from the request into the provided iTip instance.
copySummary ( Horde_Itip_Event $itip ) : null Copy the summary from the request into the provided iTip instance.
copyUid ( Horde_Itip_Event $itip ) : null Copy the uid from the request into the provided iTip instance.
getDescription ( ) : string Return the description for the event.
getLocation ( ) : string Return the location for the event.
getOrganizerParameters ( ) : array 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 ( string $description ) : null Set the description for the event.
setLocation ( string $location ) : null Set the location for the event.
setOrganizer ( string $organizer, array $parameters ) : null Set the organizer of the iTip event.
setPercentComplete ( integer $percent ) Set the percentage complete for the vTodo.
setSequence ( string $sequence ) : null Set the sequence for the event.
setStart ( string $start, array $parameters ) : null Set the start of the iTip event.
setSummary ( string $summary ) : null Set the summary for the event.
setUid ( string $uid ) : null Set the uid of the iTip event.

Method Details

__construct() public method

Constructor.
public __construct ( Horde_Icalendar_Vtodo $vevent )
$vevent Horde_Icalendar_Vtodo The iCalendar object that will be wrapped by this instance.

copyEventInto() public method

Copy the details from an event into this one.
public copyEventInto ( Horde_Itip_Event $event ) : null
$event Horde_Itip_Event The event to copy from.
return null

getEnd() public method

Return the end of the iTip event.
public getEnd ( ) : string
return string The end of the event.

getMethod() public method

Return the method of the iTip request.
public getMethod ( ) : string
return string The method of the request.

getOrganizer() public method

Return the organizer of the iTip event.
public getOrganizer ( ) : string
return string The organizer of the event.

getPercentComplete() public method

Return the PERCENT-COMPLETE attribute.
public getPercentComplete ( ) : integer
return integer

getStart() public method

Return the start of the iTip event.
public getStart ( ) : string
return string The start of the event.

getStartParameters() public method

Return the start parameters of the iTip event.
public getStartParameters ( ) : array
return array The start parameters of the event.

getSummary() public method

Return the summary for the event.
public getSummary ( ) : string
return string The summary.

getUid() public method

Return the uid of the iTip event.
public getUid ( ) : string
return string The uid of the event.

getVevent() public method

Returns the wrapped vTodo.
public getVevent ( ) : Horde_Icalendar_Vtodo
return Horde_Icalendar_Vtodo The wrapped todo.

setAttendee() public method

Set the attendee parameters.
public setAttendee ( string $attendee, string $common_name, string $status ) : null
$attendee string The mail address of the attendee.
$common_name string Common name of the attendee.
$status string Attendee status (ACCPETED, DECLINED, TENTATIVE)
return null