PHP Class Horde_Service_Vimeo, horde

Author: Michael J. Rubinsky ([email protected])

Mostra file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_cache	Horde_Cache	An optional cache object
$_cache_lifetime	integer	The lifetime of any cached data in seconds.
$_format	string	Obviously does not apply to the getEmbedJson() method. php - serialized php array json - json encoded
$_http_client	Horde_Http_Client	HTTP client object to use for accessing the Vimeo API.

Public Methods

Method	Description
factory ( string $driver = 'Simple', array $params = null ) : Horde_Service_Vimeo	Facory method. Attempt to return a concrete Horde_Service_Vimeo instance based on the parameters. A 'http_client' parameter is required. An optional 'cache' and 'cache_lifetime' parameters are also taken.
setFormat ( string $format )	Setter for changing the format parameter

Protected Methods

Method	Description
__construct ( Horde_Http_Client $http_client, array $params ) : Horde_Service_Vimeo	Constructor

Method Details

__construct() protected method

Constructor

protected __construct ( Horde_Http_Client $http_client, array $params ) : Horde_Service_Vimeo
$http_client	Horde_Http_Client	Http client object.
$params	array	An array of any other parameters or optional object dependencies.
return	Horde_Service_Vimeo	object

factory() public static method

Facory method. Attempt to return a concrete Horde_Service_Vimeo instance based on the parameters. A 'http_client' parameter is required. An optional 'cache' and 'cache_lifetime' parameters are also taken.

public static factory ( string $driver = 'Simple', array $params = null ) : Horde_Service_Vimeo
$driver	string	The concrete class to instantiate.
$params	array	An array containing any parameters the class needs.
return	Horde_Service_Vimeo	object

setFormat() public method

Setter for changing the format parameter

public setFormat ( string $format )
$format	string	The data format requested.

Property Details

$_cache protected_oe property

An optional cache object

protected Horde_Cache $_cache
return	Horde_Cache

$_cache_lifetime protected_oe property

The lifetime of any cached data in seconds.

protected int $_cache_lifetime
return	integer

$_format protected_oe property

Obviously does not apply to the getEmbedJson() method. php - serialized php array json - json encoded

protected string $_format
return	string

$_http_client protected_oe property

HTTP client object to use for accessing the Vimeo API.

protected Horde_Http_Client $_http_client
return	Horde_Http_Client