PHP Class Horde_OpenXchange_Events, horde

Author: Jan Schneider ([email protected])

Inheritance: extends Horde_OpenXchange_EventsAndTasks

Show file Open project: horde/horde

Protected Properties

Property	Type	Description
$_folderType	string	The folder category.

Public Methods

Method	Description
__construct ( array $params = [] )	Constructor.
getEvent ( integer $folder, integer $id ) : array	Returns an event.
listEvents ( integer $folder = null, Horde_Date $start = null, Horde_Date $end = null ) : array	Returns a list events.

Method Details

__construct() public method

Constructor.

public __construct ( array $params = [] )
$params	array	List of optional parameters: - client: (Horde_Http_Client) An HTTP client. - endpoint: (string) The URI of the OX API endpoint. - user: (string) Authentication user. - password: (string) Authentication password.

getEvent() public method

Returns an event.

public getEvent ( integer $folder, integer $id ) : array
$folder	integer	A folder ID.
$id	integer	An event ID.
return	array	The event hash.

listEvents() public method

Returns a list events.

public listEvents ( integer $folder = null, Horde_Date $start = null, Horde_Date $end = null ) : array
$folder	integer	A folder ID. If empty, returns events of all visible calendars.
$start	Horde_Date	Start date, defaults to epoch.
$end	Horde_Date	End date, defaults to maximum date possible.
return	array	List of event hashes.

Property Details

$_folderType protected property

The folder category.

protected string $_folderType
return	string