Horde_Itip_Response
in package
Handles Itip response 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
Table of Contents
- $_request : Horde_Itip_Event
- The request we are going to answer.
- $_resource : Horde_Itip_Resource
- The requested resource.
- __construct() : mixed
- Constructor.
- getIcalendar() : Horde_Icalendar
- Return the response as an iCalendar object.
- getMessage() : array<string|int, mixed>
- Return the response as a MIME message.
- getMultiPartMessage() : array<string|int, mixed>
- Return the response as a MIME message.
- getRequest() : Horde_Itip_Event
- Return the original request.
- getVevent() : Horde_Icalendar_Vevent
- Return the response as an iCalendar vEvent object.
- _setIcsFilename() : mixed
Properties
$_request
The request we are going to answer.
private
Horde_Itip_Event
$_request
$_resource
The requested resource.
private
Horde_Itip_Resource
$_resource
Methods
__construct()
Constructor.
public
__construct(Horde_Itip_Event $request, Horde_Itip_Resource $resource) : mixed
Parameters
- $request : Horde_Itip_Event
-
The request this instance will respond to.
- $resource : Horde_Itip_Resource
-
The requested resource.
Return values
mixed —getIcalendar()
Return the response as an iCalendar object.
public
getIcalendar(Horde_Itip_Response_Type $type, Horde_Itip_Response_Options $options) : Horde_Icalendar
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $options : Horde_Itip_Response_Options
-
The options for the response.
Return values
Horde_Icalendar —The response object.
getMessage()
Return the response as a MIME message.
public
getMessage(Horde_Itip_Response_Type $type, Horde_Itip_Response_Options $options) : array<string|int, mixed>
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $options : Horde_Itip_Response_Options
-
The options for the response.
Return values
array<string|int, mixed> —A list of two object: The mime headers and the mime message.
getMultiPartMessage()
Return the response as a MIME message.
public
getMultiPartMessage(Horde_Itip_Response_Type $type, Horde_Itip_Response_Options $options) : array<string|int, mixed>
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $options : Horde_Itip_Response_Options
-
The options for the response.
Return values
array<string|int, mixed> —A list of two object: The mime headers and the mime message.
getRequest()
Return the original request.
public
getRequest() : Horde_Itip_Event
Return values
Horde_Itip_Event —The original request.
getVevent()
Return the response as an iCalendar vEvent object.
public
getVevent(Horde_Itip_Response_Type $type[, Horde_Icalendar|bool $vCal = false ]) : Horde_Icalendar_Vevent
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $vCal : Horde_Icalendar|bool = false
-
The parent container or false if not provided.
Return values
Horde_Icalendar_Vevent —The response object.
_setIcsFilename()
protected
_setIcsFilename(Horde_Mime_Part &$message) : mixed
Parameters
- $message : Horde_Mime_Part