ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Sabre\VObject\Settings Class Reference

This class provides a list of global defaults for vobject. More...

+ Collaboration diagram for Sabre\VObject\Settings:

Static Public Attributes

static $minDate = '1900-01-01'
 The minimum date we accept for various calculations with dates, such as recurrences. More...
 
static $maxDate = '2100-01-01'
 The maximum date we accept for various calculations with dates, such as recurrences. More...
 
static $maxRecurrences = 3500
 The maximum number of recurrences that will be generated. More...
 

Detailed Description

This class provides a list of global defaults for vobject.

Some of these started to appear in various classes, so it made a bit more sense to centralize them, so it's easier for user to find and change these.

The global nature of them does mean that changing the settings for one instance has a global influence.

Author
Evert Pot (http://evertpot.com/) http://sabre.io/license/ Modified BSD License

Definition at line 18 of file Settings.php.

Field Documentation

◆ $maxDate

Sabre\VObject\Settings::$maxDate = '2100-01-01'
static

The maximum date we accept for various calculations with dates, such as recurrences.

The choice of 2100 is pretty arbitrary, but should cover most appointments made for many years to come.

Definition at line 37 of file Settings.php.

Referenced by Sabre\VObject\FreeBusyGenerator\setTimeRange().

◆ $maxRecurrences

Sabre\VObject\Settings::$maxRecurrences = 3500
static

The maximum number of recurrences that will be generated.

This setting limits the maximum of recurring events that this library generates in its recurrence iterators.

This is a security measure. Without this, it would be possible to craft specific events that recur many, many times, potentially DDOSing the server.

The default (3500) allows creation of a dialy event that goes on for 10 years, which is hopefully long enough for most.

Set this value to -1 to disable this control altogether.

Definition at line 54 of file Settings.php.

Referenced by Sabre\VObject\FreeBusyGenerator\calculateBusy(), Sabre\VObject\Recur\EventIterator\MaxInstancesTest\testExceedMaxRecurrences(), and Sabre\VObject\Recur\EventIterator\valid().

◆ $minDate

Sabre\VObject\Settings::$minDate = '1900-01-01'
static

The minimum date we accept for various calculations with dates, such as recurrences.

The choice of 1900 is pretty arbitrary, but it covers most common use-cases. In particular, it covers birthdates for virtually everyone alive on earth, which is less than 5 people at the time of writing.

Definition at line 28 of file Settings.php.

Referenced by Sabre\VObject\FreeBusyGenerator\setTimeRange().


The documentation for this class was generated from the following file: