Documentation

Kronolith_FreeBusy
in package

Free/Busy functionality.

Tags
author

Chuck Hagenbuch chuck@horde.org

Table of Contents

generate()  : string
Generates the free/busy text for $calendars.
get()  : Horde_Icalendar_Vfreebusy|object
Retrieves the free/busy information for a given email address, if any information is available.
getForUser()  : Horde_Icalendar_Vfreebusy|object
Retrieves the free/busy information for a given user.
getUrl()  : mixed
Searches address books for the freebusy URL for a given email address.
toJson()  : object
Converts free/busy data to a simple object suitable to be transferred as json.

Methods

generate()

Generates the free/busy text for $calendars.

public static generate(string|array<string|int, mixed> $calendars[, int $startstamp = null ][, int $endstamp = null ][, bool $returnObj = false ][, string $user = null ]) : string
Parameters
$calendars : string|array<string|int, mixed>

The calendar to view free/busy slots for.

$startstamp : int = null

The start of the time period to retrieve.

$endstamp : int = null

The end of the time period to retrieve.

$returnObj : bool = false

Default false. Return a vFreebusy object instead of text.

$user : string = null

Set organizer to this user.

Tags
throws

Horde_Exception, Kronolith_Exception

Return values
string —

The free/busy text.

get()

Retrieves the free/busy information for a given email address, if any information is available.

public static get(string $email[, bool $json = false ]) : Horde_Icalendar_Vfreebusy|object
Parameters
$email : string

The email address to look for.

$json : bool = false

Whether to return the free/busy data as a simple object suitable to be transferred as json.

Tags
throws
Kronolith_Exception
Return values
Horde_Icalendar_Vfreebusy|object —

Free/busy component.

getForUser()

Retrieves the free/busy information for a given user.

public static getForUser(string $user[, array<string|int, mixed> $opts = array() ]) : Horde_Icalendar_Vfreebusy|object
Parameters
$user : string

The user to look for.

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

Options:

  • json: (boolean) Whether to return the free/busy data as a simple object suitable to be transferred as json. DEFAULT: false
  • start: (integer) The start of the time period to retrieve. DEFAULT: now
  • end: (integer) The end of the time period to retrieve. DEFAULT: now + freebusy_days pref
Tags
since

Kronolith 4.3.0

throws
Kronolith_Exception
Return values
Horde_Icalendar_Vfreebusy|object —

Free/busy component.

getUrl()

Searches address books for the freebusy URL for a given email address.

public static getUrl(string $email) : mixed
Parameters
$email : string

The email address to look for.

Return values
mixed —

The url on success or false on failure.

toJson()

Converts free/busy data to a simple object suitable to be transferred as json.

public static toJson(Horde_Icalendar_Vfreebusy $fb) : object
Parameters
$fb : Horde_Icalendar_Vfreebusy

A Free/busy component.

Return values
object —

A simple object representation.

Search results