Documentation

Horde_Kolab_Resource_Freebusy
in package

Retrieves free/busy data for an email address.

Tags
todo

Merge this class with Kolab_FreeBusy and Kronolith_FreeBusy into a single Horde_Freebusy handler.

category

Kolab

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

$_instances  : array<string|int, mixed>
Singleton instances.
$_params  : array<string|int, mixed>
Class parameters.
factory()  : Horde_Kolab_Resource_Getfreebusy
Attempts to return a concrete Horde_Kolab_Resource_Getfreebusy instance based on $driver.
get()  : Horde_Icalendar_vfreebusy
Retrieve Free/Busy data for the specified resource.
singleton()  : Horde_Token
Attempts to return a reference to a concrete Horde_Kolab_Resource_Getfreebusy instance based on $driver.
__construct()  : mixed
Constructor.
getUrl()  : string
Retrieve Free/Busy URL for the specified resource id.

Properties

$_instances

Singleton instances.

protected static array<string|int, mixed> $_instances = array()

$_params

Class parameters.

protected array<string|int, mixed> $_params

Methods

factory()

Attempts to return a concrete Horde_Kolab_Resource_Getfreebusy instance based on $driver.

public static factory(mixed $driver[, array<string|int, mixed> $params = array() ]) : Horde_Kolab_Resource_Getfreebusy
Parameters
$driver : mixed

The type of concrete Horde_Kolab_Resource_Getfreebusy subclass to return.

$params : array<string|int, mixed> = array()

A hash containing any additional configuration or connection parameters a subclass might need.

Return values
Horde_Kolab_Resource_Getfreebusy —

The newly created concrete Horde_Kolab_Resource_Getfreebusy instance, or false an error.

get()

Retrieve Free/Busy data for the specified resource.

public get(string $resource) : Horde_Icalendar_vfreebusy
Parameters
$resource : string

Fetch the Free/Busy data for this resource (usually a mail address).

Return values
Horde_Icalendar_vfreebusy —

The Free/Busy data.

singleton()

Attempts to return a reference to a concrete Horde_Kolab_Resource_Getfreebusy instance based on $driver.

public static singleton([mixed $driver = null ][, array<string|int, mixed> $params = array() ]) : Horde_Token

It will only create a new instance if no Horde_Kolab_Resource_Getfreebusy instance with the same parameters currently exists.

This method must be invoked as: $var = Horde_Kolab_Resource_Getfreebusy::singleton();

Parameters
$driver : mixed = null

The type of concrete Horde_Kolab_Resource_Getfreebusy subclass to return.

$params : array<string|int, mixed> = array()

A hash containing any additional configuration or connection parameters a subclass might need.

Return values
Horde_Token —

The concrete Horde_Kolab_Resource_Getfreebusy reference, or false on error.

__construct()

Constructor.

protected __construct(array<string|int, mixed> $params) : mixed
Parameters
$params : array<string|int, mixed>

A hash containing any additional configuration or connection parameters a subclass might need.

Return values
mixed —

getUrl()

Retrieve Free/Busy URL for the specified resource id.

protected getUrl(string $resource) : string
Parameters
$resource : string

The id of the resource (usually a mail address).

Return values
string —

The Free/Busy URL for that resource.

Search results