Class Horde_Kolab_Resource_Freebusy

Description

Retrieves free/busy data for an email address.

Copyright 2004-2010 Klarälvdalens Datakonsult AB

See the enclosed file COPYING for license information (LGPL>=2.1). If you did not receive this file, see http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

Located in /Kolab_Resource/lib/Horde/Kolab/Resource/Freebusy.php (line 32)


	
			
Direct descendents
Class Description
 class Horde_Kolab_Resource_Freebusy_Mock Retrieves free/busy mockup data.
 class Horde_Kolab_Resource_Freebusy_Kolab Retrieves free/busy data for an email address on a Kolab server.
Variable Summary
 static array $_instances
 array $_params
Method Summary
 static Horde_Kolab_Resource_Getfreebusy factory (mixed $driver, [array $params = array()])
 static Horde_Token singleton ([mixed $driver = null], [array $params = array()])
 Horde_Kolab_Resource_Freebusy __construct (array $params)
 Horde_iCalendar_vfreebusy get (string $resource)
 string getUrl (string $resource)
Variables
static array $_instances = array() (line 39)

Singleton instances.

  • access: protected
array $_params (line 46)

Class parameters.

  • access: protected
Methods
static factory (line 73)

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

  • return: The newly created concrete Horde_Kolab_Resource_Getfreebusy instance, or false an error.
  • access: public
static Horde_Kolab_Resource_Getfreebusy factory (mixed $driver, [array $params = array()])
  • mixed $driver: The type of concrete Horde_Kolab_Resource_Getfreebusy subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
static singleton (line 108)

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

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:

  1. $var Horde_Kolab_Resource_Getfreebusy::singleton();

  • return: The concrete Horde_Kolab_Resource_Getfreebusy reference, or false on error.
  • access: public
static Horde_Token singleton ([mixed $driver = null], [array $params = array()])
  • mixed $driver: The type of concrete Horde_Kolab_Resource_Getfreebusy subclass to return.
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
Constructor __construct (line 54)

Constructor.

  • access: protected
Horde_Kolab_Resource_Freebusy __construct (array $params)
  • array $params: A hash containing any additional configuration or connection parameters a subclass might need.
get (line 156)

Retrieve Free/Busy data for the specified resource.

  • return: The Free/Busy data.
  • access: public
Horde_iCalendar_vfreebusy get (string $resource)
  • string $resource: Fetch the Free/Busy data for this resource (usually a mail address).

Redefined in descendants as:
getUrl (line 143)

Retrieve Free/Busy URL for the specified resource id.

  • return: The Free/Busy URL for that resource.
  • access: protected
string getUrl (string $resource)
  • string $resource: The id of the resource (usually a mail address).

Redefined in descendants as:

Documentation generated on Sun, 30 Jan 2011 05:17:37 +0000 by phpDocumentor 1.4.3