Documentation

Kronolith_FreeBusy_View_Workweek extends Kronolith_FreeBusy_View_Week
in package

This class represent a work week of free busy information sets.

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information.

Tags
author

Mike Cochrane mike@graftonhall.co.nz

author

Jan Schneider jan@horde.org

Table of Contents

$_days  : int
Number of days
$view  : string
This view type
$_end  : mixed
$_endHour  : mixed
$_optionalMembers  : mixed
$_optionalResourceMembers  : mixed
$_requiredMembers  : mixed
$_requiredResourceMembers  : mixed
$_start  : mixed
$_startHour  : mixed
$_timeBlocks  : mixed
addOptionalMember()  : mixed
Adds an optional attendee
addOptionalResourceMember()  : mixed
Adds an optional resource
addRequiredMember()  : mixed
Adds a required attendee
addRequiredResourceMember()  : mixed
Adds a required resource
factory()  : mixed
Attempts to return a concrete Kronolith_FreeBusy_View instance based on $view.
render()  : string
Renders the fb view
singleton()  : mixed
Attempts to return a reference to a concrete Kronolith_FreeBusy_View instance based on $view. It will only create a new instance if no Kronolith_FreeBusy_View instance with the same parameters currently exists.
_getBlocks()  : string
Render the blocks
_hours()  : mixed
_render()  : mixed
_title()  : mixed

Properties

$_days

Number of days

public int $_days = 5

$view

This view type

public string $view = 'workweek'

$_end

protected mixed $_end

$_endHour

protected mixed $_endHour

$_optionalMembers

protected mixed $_optionalMembers = array()

$_optionalResourceMembers

protected mixed $_optionalResourceMembers = array()

$_requiredMembers

protected mixed $_requiredMembers = array()

$_requiredResourceMembers

protected mixed $_requiredResourceMembers = array()

$_start

protected mixed $_start

$_startHour

protected mixed $_startHour

$_timeBlocks

protected mixed $_timeBlocks = array()

Methods

addOptionalMember()

Adds an optional attendee

public addOptionalMember(Horde_Icalendar_Vfreebusy $vFreebusy) : mixed
Parameters
$vFreebusy : Horde_Icalendar_Vfreebusy
Return values
mixed

addOptionalResourceMember()

Adds an optional resource

public addOptionalResourceMember(Horde_Icalendar_Vfreebusy $vFreebusy) : mixed
Parameters
$vFreebusy : Horde_Icalendar_Vfreebusy
Return values
mixed

addRequiredMember()

Adds a required attendee

public addRequiredMember(Horde_Icalendar_Vfreebusy $vFreebusy) : mixed
Parameters
$vFreebusy : Horde_Icalendar_Vfreebusy
Return values
mixed

addRequiredResourceMember()

Adds a required resource

public addRequiredResourceMember(Horde_Icalendar_Vfreebusy $vFreebusy) : mixed
Parameters
$vFreebusy : Horde_Icalendar_Vfreebusy
Return values
mixed

factory()

Attempts to return a concrete Kronolith_FreeBusy_View instance based on $view.

public static factory(string $view) : mixed
Parameters
$view : string

The type of concrete Kronolith_FreeBusy_View subclass to return.

Return values
mixed

The newly created concrete Kronolith_FreeBusy_View instance, or false on an error.

render()

Renders the fb view

public render([Horde_Date $day = null ]) : string
Parameters
$day : Horde_Date = null

The day to render

Tags
global

Horde_Prefs $prefs

Return values
string

The html of the rendered fb view.

singleton()

Attempts to return a reference to a concrete Kronolith_FreeBusy_View instance based on $view. It will only create a new instance if no Kronolith_FreeBusy_View instance with the same parameters currently exists.

public static singleton(string $view) : mixed

This method must be invoked as: $var = &Kronolith_FreeBusy_View::singleton()

Parameters
$view : string

The type of concrete Kronolith_FreeBusy_View subclass to return.

Return values
mixed

The created concrete Kronolith_FreeBusy_View instance, or false on an error.

_getBlocks()

Render the blocks

protected _getBlocks(Horde_Icalendar_Vfreebusy $member, array<string|int, mixed> $periods, string $blockfile, string $label) : string
Parameters
$member : Horde_Icalendar_Vfreebusy

Member's freebusy info

$periods : array<string|int, mixed>

Free periods

$blockfile : string

Template file to use for blocks

$label : string

Label to use

Return values
string

The block html

_hours()

protected abstract _hours() : mixed
Return values
mixed

_render()

protected abstract _render([Horde_Date $day = null ]) : mixed
Parameters
$day : Horde_Date = null
Return values
mixed

_title()

protected abstract _title() : mixed
Return values
mixed

Search results