Kronolith_CalendarsManager
in package
Handles management of the various global calendar lists.
Tags
Table of Contents
- $_allCalendars : array<string|int, mixed>
- List of all available internal calendars.
- $_allExternal : array<string|int, mixed>
- List of all available external calendars.
- $_allHolidays : array<string|int, mixed>
- List of all available Holiday calendars.
- $_allRemote : array<string|int, mixed>
- List of all available remote calendars.
- $_allResource : mixed
- Lazy loaded list of all resource calendars.
- $_displayCalendars : array<string|int, mixed>
- List of all internal calendars that are currently selected to be visible.
- $_displayExternal : array<string|int, mixed>
- List of external (listTimeObjects) calendars selected for display.
- $_displayHolidays : array<string|int, mixed>
- List of all holidays selected for display.
- $_displayHolidaysInternal : array<string|int, mixed>
- 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.
- $_displayRemote : array<string|int, mixed>
- List of remote calendars selected for display.
- $_displayResource : array<string|int, mixed>
- List of resource calendars selected for display.
- __construct() : mixed
- Const'r Sets up various display lists and session variables:
- get() : array<string|int, mixed>
- Return the requested list.
- getEntry() : mixed
- Shortcut method for obtaining a single entry in one of the calendar lists
- set() : mixed
- Set or replace an existing list with $value.
- _checkDisplayCals() : mixed
- Update display preferences
- _checkForOwnedCalendar() : mixed
- Check that the user owns a calendar and if not, creates one.
- _checkToggleCalendars() : mixed
- Check for single, "toggle" calendars and set display lists and session values appropriately.
- _getAllExternal() : array<string|int, mixed>
- Return all known external calendars.
- _getAllHolidays() : array<string|int, mixed>
- Return list of all available holidays drivers.
- _getAllResource() : array<string|int, mixed>
- Return list of all resource calendars.
- _getDisplayExternal() : array<string|int, mixed>
- Return all external calendars selected for display.
- _getDisplayHolidays() : array<string|int, mixed>
- Return list of holiday calendars to be displayed.
- _getRemoteCalendars() : mixed
Properties
$_allCalendars
List of all available internal calendars.
protected
array<string|int, mixed>
$_allCalendars
= array()
$_allExternal
List of all available external calendars.
protected
array<string|int, mixed>
$_allExternal
= alse
$_allHolidays
List of all available Holiday calendars.
protected
array<string|int, mixed>
$_allHolidays
= alse
$_allRemote
List of all available remote calendars.
protected
array<string|int, mixed>
$_allRemote
= alse
$_allResource
Lazy loaded list of all resource calendars.
protected
mixed
$_allResource
= alse
$_displayCalendars
List of all internal calendars that are currently selected to be visible.
protected
array<string|int, mixed>
$_displayCalendars
$_displayExternal
List of external (listTimeObjects) calendars selected for display.
protected
array<string|int, mixed>
$_displayExternal
= alse
$_displayHolidays
List of all holidays selected for display.
protected
array<string|int, mixed>
$_displayHolidays
= alse
$_displayHolidaysInternal
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.
protected
array<string|int, mixed>
$_displayHolidaysInternal
= array()
$_displayRemote
List of remote calendars selected for display.
protected
array<string|int, mixed>
$_displayRemote
$_displayResource
List of resource calendars selected for display.
protected
array<string|int, mixed>
$_displayResource
= array()
Methods
__construct()
Const'r Sets up various display lists and session variables:
public
__construct([string $user = null ]) : mixed
Always set:
- allCalendars
- displayCalendars
- displayResource
Lazy loaded:
- allRemote
- allExternal
- allHolidays
- allResource
- displayRemote
- displayExternal
- displayHolidays
Parameters
- $user : string = null
-
The user to initialize for, if not the current. @since 4.2.4
Return values
mixed —get()
Return the requested list.
public
get(string $list) : array<string|int, mixed>
Parameters
- $list : string
-
A Kronolith:: calendar manager constant.
Return values
array<string|int, mixed> —getEntry()
Shortcut method for obtaining a single entry in one of the calendar lists
public
getEntry(string $list, string $entry) : mixed
Parameters
- $list : string
-
The calendar list to obtain an entry from.
- $entry : string
-
The entry to retrieve.
Return values
mixed —The requested value | false if not found.
set()
Set or replace an existing list with $value.
public
set(string $list, array<string|int, mixed> $value) : mixed
Parameters
- $list : string
-
The list to set.
- $value : array<string|int, mixed>
-
The value to set it to.
Return values
mixed —_checkDisplayCals()
Update display preferences
protected
_checkDisplayCals() : mixed
Return values
mixed —_checkForOwnedCalendar()
Check that the user owns a calendar and if not, creates one.
protected
_checkForOwnedCalendar() : mixed
Return values
mixed —_checkToggleCalendars()
Check for single, "toggle" calendars and set display lists and session values appropriately.
protected
_checkToggleCalendars() : mixed
Return values
mixed —_getAllExternal()
Return all known external calendars.
protected
_getAllExternal() : array<string|int, mixed>
Return values
array<string|int, mixed> —_getAllHolidays()
Return list of all available holidays drivers.
protected
_getAllHolidays() : array<string|int, mixed>
Return values
array<string|int, mixed> —The available holidays.
_getAllResource()
Return list of all resource calendars.
protected
_getAllResource() : array<string|int, mixed>
Return values
array<string|int, mixed> —Resource calendars, keyed by calendar id.
_getDisplayExternal()
Return all external calendars selected for display.
protected
_getDisplayExternal() : array<string|int, mixed>
Return values
array<string|int, mixed> —_getDisplayHolidays()
Return list of holiday calendars to be displayed.
protected
_getDisplayHolidays() : array<string|int, mixed>
Return values
array<string|int, mixed> —The holiday calendars to display.
_getRemoteCalendars()
protected
_getRemoteCalendars() : mixed