API Documentation
\
Kronolith
Backup

\Kronolith_CalendarsManager

Handles management of the various global calendar lists.

Summary

Methods
Properties
Constants
__construct()
get()
set()
getEntry()
No public properties found
No constants found
_checkDisplayCals()
_checkToggleCalendars()
_checkForOwnedCalendar()
_getAllExternal()
_getDisplayExternal()
_getAllHolidays()
_getDisplayHolidays()
_getAllResource()
_getRemoteCalendars()
$_allCalendars
$_allRemote
$_allExternal
$_allHolidays
$_displayCalendars
$_displayRemote
$_displayResource
$_allResource
$_displayHolidaysInternal
$_displayHolidays
$_displayExternal
N/A
No private methods found
No private properties found
N/A

Properties

$_allCalendars

$_allCalendars : array

List of all available internal calendars.

Type

array

$_allRemote

$_allRemote : array

List of all available remote calendars.

Type

array

$_allExternal

$_allExternal : array

List of all available external calendars.

Type

array

$_allHolidays

$_allHolidays : array

List of all available Holiday calendars.

Type

array

$_displayCalendars

$_displayCalendars : array

List of all internal calendars that are currently selected to be visible.

Type

array

$_displayRemote

$_displayRemote : array

List of remote calendars selected for display.

Type

array

$_displayResource

$_displayResource : array

List of resource calendars selected for display.

Type

array

$_allResource

$_allResource : \array.

Lazy loaded list of all resource calendars.

Type

\array.

$_displayHolidaysInternal

$_displayHolidaysInternal : array

List of holiday calendars selected for display. Used internally to hold the user prefs for displayed holiday calendars before we need to see if they are all available.

Type

array

$_displayHolidays

$_displayHolidays : array

List of all holidays selected for display.

Type

array

$_displayExternal

$_displayExternal : array

List of external (listTimeObjects) calendars selected for display.

Type

array

Methods

__construct()

__construct(string  $user = null)

Const'r Sets up various display lists and session variables:

Always set:

  • allCalendars
  • displayCalendars
  • displayResource

Lazy loaded:

  • allRemote
  • allExternal
  • allHolidays
  • allResource
  • displayRemote
  • displayExternal
  • displayHolidays

Parameters

string $user

The user to initialize for, if not the current. @since 4.2.4

get()

get(string  $list) : array

Return the requested list.

Parameters

string $list

A Kronolith:: calendar manager constant.

Returns

array

set()

set(string  $list, array  $value)

Set or replace an existing list with $value.

Parameters

string $list

The list to set.
array $value

The value to set it to.

getEntry()

getEntry(string  $list, string  $entry) : mixed

Shortcut method for obtaining a single entry in one of the calendar lists

Parameters

string $list

The calendar list to obtain an entry from.
string $entry

The entry to retrieve.

Returns

mixed —

The requested value | false if not found.

_checkDisplayCals()

_checkDisplayCals()

Update display preferences

_checkToggleCalendars()

_checkToggleCalendars()

Check for single, "toggle" calendars and set display lists and session values appropriately.

_checkForOwnedCalendar()

_checkForOwnedCalendar()

Check that the user owns a calendar and if not, creates one.

_getAllExternal()

_getAllExternal() : array

Return all known external calendars.

Returns

array

_getDisplayExternal()

_getDisplayExternal() : array

Return all external calendars selected for display.

Returns

array

_getAllHolidays()

_getAllHolidays() : array

Return list of all available holidays drivers.

Returns

array —

The available holidays.

_getDisplayHolidays()

_getDisplayHolidays() : array

Return list of holiday calendars to be displayed.

Returns

array —

The holiday calendars to display.

_getAllResource()

_getAllResource() : array

Return list of all resource calendars.

Returns

array —

Resource calendars, keyed by calendar id.

_getRemoteCalendars()

_getRemoteCalendars()