Documentation

Timeobjects_Api extends Horde_Registry_Api
in package

API methods for exposing various bits of data via the listTimeObjects API.

Tags
author

Michael J. Rubinsky mrubinsk@horde.org

license

http://www.horde.org/licenses/bsd BSD

category

Horde

Table of Contents

$_links  : array<string|int, mixed>
Links.
listTimeObjectCategories()  : array<string|int, mixed>
Returns the available categories.
listTimeObjects()  : array<string|int, mixed>
Returns time objects for the requested category.

Properties

Links.

protected array<string|int, mixed> $_links = array( // @TODO: Probably implement a URL endpoint or something so we can // link to the correct external site depending on what time object // category we are referring to. 'show' => '#', )

Methods

listTimeObjectCategories()

Returns the available categories.

public listTimeObjectCategories() : array<string|int, mixed>
Return values
array<string|int, mixed>

An array of available time object categories.

listTimeObjects()

Returns time objects for the requested category.

public listTimeObjects(array<string|int, mixed> $time_categories, mixed $start, mixed $end) : array<string|int, mixed>
Parameters
$time_categories : array<string|int, mixed>

An array of categories to list.

$start : mixed

The start of the time period to list for.

$end : mixed

The end of the time period to list for.

Return values
array<string|int, mixed>

A list of time object hashes.

Search results