Method |
Description |
|
__construct ( string $rrule = null, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null ) |
Construct a new Rule. |
|
createFromArray ( array $rrule, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null ) : Rule |
Create a Rule object based on a RRULE array. |
|
createFromString ( string $rrule, string | DateTime $startDate = null, DateTime | null $endDate = null, string $timezone = null ) : Rule |
Create a Rule object based on a RRULE string. |
|
getByDay ( ) : array |
Get an array of days of the week (SU, MO, TU, . |
|
getByDayTransformedToWeekdays ( ) : array |
Get an array of Weekdays |
|
getByHour ( ) : array |
Get an array of hours of the day. |
|
getByMinute ( ) : array |
Get an array of minutes within an hour. |
|
getByMonth ( ) : array |
Get an array of months of the year. |
|
getByMonthDay ( ) : array |
Get an array of days of the month. |
|
getBySecond ( ) : array |
Get an array of seconds within a minute. |
|
getBySetPosition ( ) : array |
Get the array of values which corresponds to the nth occurrence within
the set of events specified by the rule. |
|
getByWeekNumber ( ) : array |
Get an array of ordinals specifying weeks of the year. |
|
getByYearDay ( ) : array |
Get an array of days of the year. |
|
getCount ( ) : integer | null |
Get the number of occurrences at which the recurrence is range-bound. |
|
getEndDate ( ) : DateTime |
|
|
getExDates ( ) : recurr\DateExclusion[] |
Get the array of dates that will not be included in a recurrence set. |
|
getFreq ( ) : integer |
Get the type of recurrence rule (as integer). |
|
getFreqAsText ( ) : string |
Get the type of recurrence rule (as text). |
|
getInterval ( ) : integer |
Get the interval that represents how often the recurrence rule repeats. |
|
getRDates ( ) : recurr\DateInclusion[] |
Get the array of dates that will be included in a recurrence set. |
|
getStartDate ( ) : DateTime |
|
|
getString ( $timezoneType = self::TZ_FLOAT ) : string |
Get the RRULE as a string |
|
getTimezone ( ) : null | string |
Get timezone to use for \DateTime() objects that are UTC. |
|
getUntil ( ) : DateTime | null |
Get the \DateTime that the recurrence lasts until. |
|
getWeekStart ( ) : string |
Get the day on which the workweek starts. |
|
getWeekStartAsNum ( ) : integer |
Get the day on which the workweek starts, as an integer from 0-6,
0 being Monday and 6 being Sunday. |
|
hasByMonth ( ) |
|
|
loadFromArray ( $parts ) : Rule |
Populate the object based on a RRULE array. |
|
loadFromString ( string $rrule ) : Rule |
Populate the object based on a RRULE string. |
|
setByDay ( array $byDay ) |
This rule specifies an array of days of the week; |
|
setByHour ( array $byHour ) |
This rule specifies an array of hours of the day. |
|
setByMinute ( array $byMinute ) |
This rule specifies an array of minutes within an hour. |
|
setByMonth ( array $byMonth ) |
This rule specifies an array of months of the year. |
|
setByMonthDay ( array $byMonthDay ) |
This rule specifies an array of days of the month. |
|
setBySecond ( array $bySecond ) |
This rule specifies an array of seconds within a minute. |
|
setBySetPosition ( array $bySetPosition ) |
This rule specifies an array of values which corresponds to the nth
occurrence within the set of events specified by the rule. Valid values
are 1 to 366 or -366 to -1. It MUST only be used in conjunction with
another BYxxx rule part. |
|
setByWeekNumber ( array $byWeekNumber ) |
This rule specifies an array of ordinals specifying weeks of the year. |
|
setByYearDay ( array $byYearDay ) |
This rule specifies an array of days of the year. |
|
setCount ( integer $count ) |
The count defines the number of occurrences at which to range-bound the
recurrence. The DTSTART counts as the first occurrence. |
|
setEndDate ( DateTime | null $endDate ) |
This date specifies the last possible instance in the recurrence set. |
|
setExDates ( array $exDates ) |
This rule specifies an array of exception dates that will not be
included in a recurrence set. |
|
setFreq ( string $freq ) |
Identifies the type of recurrence rule. |
|
setInterval ( integer $interval ) |
The interval represents how often the recurrence rule repeats. |
|
setRDates ( array $rDates ) |
This rule specifies an array of dates that will be
included in a recurrence set. |
|
setStartDate ( DateTime | null $startDate, boolean | null $includeInString = null ) |
This date specifies the first instance in the recurrence set. |
|
setTimezone ( string $timezone ) |
|
|
setUntil ( DateTime $until ) |
Define a \DateTime value which bounds the recurrence rule in an
inclusive manner. If the value specified is synchronized with the
specified recurrence, this DateTime becomes the last instance of the
recurrence. If not present, and a COUNT is also not present, the RRULE
is considered to repeat forever. |
|
setWeekStart ( string $weekStart ) |
This rule specifies the day on which the workweek starts. |
|