Horde_Itip
in package
Handles iTip invitation requests/responses.
Copyright 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
- $_response : Horde_Itip_Response
- The iTip response.
- __construct() : mixed
- Constructor.
- factory() : Horde_Itip
- Factory for generating an iTip handler for an iCalendar invitation.
- getIcalendarResponse() : Horde_Icalendar
- Return the response as an iCalendar object.
- getVeventResponse() : Horde_Icalendar_Vevent
- Return the response as an iCalendar vEvent object.
- prepareResponse() : Horde_Itip_Response
- Factory for generating a response object for an iCalendar invitation.
- sendMultipartResponse() : null
- Send the invitation response as a multi part MIME message.
- sendSinglepartResponse() : array<string|int, mixed>
- Send the response as a single part MIME message.
- vTodoFactory() : mixed
- Factory for generating a response object for a vTodo assignment request.
Properties
$_response
The iTip response.
private
Horde_Itip_Response
$_response
Methods
__construct()
Constructor.
public
__construct(Horde_Itip_Response $response) : mixed
Parameters
- $response : Horde_Itip_Response
-
The iTip response.
Return values
mixed —factory()
Factory for generating an iTip handler for an iCalendar invitation.
public
static factory(Horde_Icalendar_Vevent $vevent, Horde_Itip_Resource $resource) : Horde_Itip
Parameters
- $vevent : Horde_Icalendar_Vevent
-
The iCalendar request.
- $resource : Horde_Itip_Resource
-
The invited resource.
Return values
Horde_Itip —The iTip handler.
getIcalendarResponse()
Return the response as an iCalendar object.
public
getIcalendarResponse(Horde_Itip_Response_Type $type, string $product_id) : Horde_Icalendar
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $product_id : string
-
The ID that should be set as the iCalendar product id.
Return values
Horde_Icalendar —The response object.
getVeventResponse()
Return the response as an iCalendar vEvent object.
public
getVeventResponse(Horde_Itip_Response_Type $type) : Horde_Icalendar_Vevent
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
Return values
Horde_Icalendar_Vevent —The response object.
prepareResponse()
Factory for generating a response object for an iCalendar invitation.
public
static prepareResponse(Horde_Icalendar_Vevent $vevent, Horde_Itip_Resource $resource) : Horde_Itip_Response
Parameters
- $vevent : Horde_Icalendar_Vevent
-
The iCalendar request.
- $resource : Horde_Itip_Resource
-
The invited resource.
Return values
Horde_Itip_Response —The prepared response.
sendMultipartResponse()
Send the invitation response as a multi part MIME message.
public
sendMultipartResponse(Horde_Itip_Response_Type $type, Horde_Itip_Response_Options $options, Horde_Mail_Transport $transport) : null
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $options : Horde_Itip_Response_Options
-
The options for the response.
- $transport : Horde_Mail_Transport
-
The mail transport.
Tags
Return values
null —sendSinglepartResponse()
Send the response as a single part MIME message.
public
sendSinglepartResponse(Horde_Itip_Response_Type $type, Horde_Itip_Response_Options $options, Horde_Mail_Transport $transport) : array<string|int, mixed>
Parameters
- $type : Horde_Itip_Response_Type
-
The response type.
- $options : Horde_Itip_Response_Options
-
The options for the response.
- $transport : Horde_Mail_Transport
-
The mail transport.
Tags
Return values
array<string|int, mixed> —A list of two object: The mime headers and the mime message.
vTodoFactory()
Factory for generating a response object for a vTodo assignment request.
public
static vTodoFactory(Horde_Icalendar_Vtodo $todo, Horde_Itip_Resource $resource) : mixed
Parameters
- $todo : Horde_Icalendar_Vtodo
-
[description]
- $resource : Horde_Itip_Resource
-
[description]