Manager

class OC\Calendar\Manager
Source:lib/private/Calendar/Manager.php#29
Implements:OCP\Calendar\IManager

Properties

Methods

public OC\Calendar\Manager::search($pattern, $searchProperties=[], $options=[], $limit=null, $offset=null)
This function is used to search and find objects within the user’s calendars.
In case $pattern is empty all events/journals/todos will be returned.
Source:

lib/private/Calendar/Manager.php#54
Parameters:
  • $pattern (string) which should match within the $searchProperties
  • $searchProperties (array) defines the properties within the query pattern should match
  • $options (array) - optional parameters:

[‘timerange’ => [‘start’ => new DateTime(...), ‘end’ => new DateTime(...)]] * $limit (int | null) - limit number of search results * $offset (int | null) - offset for paging of search results
Returns:

array an array of events/journals/todos which are arrays of arrays of key-value-pairs
Since:

13.0.0
public OC\Calendar\Manager::isEnabled()
Check if calendars are available
Source:lib/private/Calendar/Manager.php#74
Returns:bool true if enabled, false if not
Since:13.0.0
public OC\Calendar\Manager::registerCalendar($calendar)
Registers a calendar
Source:

lib/private/Calendar/Manager.php#85
Parameters:
Returns:

void
Since:

13.0.0
public OC\Calendar\Manager::unregisterCalendar($calendar)
Unregisters a calendar
Source:

lib/private/Calendar/Manager.php#96
Parameters:
Returns:

void
Since:

13.0.0
public OC\Calendar\Manager::register($callable)
In order to improve lazy loading a closure can be registered which will be called in case
calendars are actually requested
Source:

lib/private/Calendar/Manager.php#108
Parameters:
  • $callable (Closure)
Returns:

void
Since:

13.0.0
public OC\Calendar\Manager::getCalendars()
Source:lib/private/Calendar/Manager.php#116
Returns:\OCP\Calendar\ICalendar[]
Since:13.0.0
public OC\Calendar\Manager::clear()
removes all registered calendar instances
Source:lib/private/Calendar/Manager.php#127
Returns:void
Since:13.0.0