| Methods |
public
|
__construct(array<string, mixed> $rrule)
Creates a recurrence object with a passed in line. Parses the line.
Creates a recurrence object with a passed in line. Parses the line.
|
#
|
protected
|
parseRrule(array<string, mixed> $rrule): void
Parses an 'RRULE' array and sets the member variables of this object.
Expects a string that looks like this: 'FREQ=WEEKLY;INTERVAL=2;BYDAY=SU,TU,WE'
Parses an 'RRULE' array and sets the member variables of this object.
Expects a string that looks like this: 'FREQ=WEEKLY;INTERVAL=2;BYDAY=SU,TU,WE'
|
#
|
public
|
getFreq(): mixed
Returns the frequency - corresponds to FREQ in RFC 2445.
Returns the frequency - corresponds to FREQ in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
protected
|
getMember(string $member): mixed
Retrieves the desired member variable and returns it (if it's set)
Retrieves the desired member variable and returns it (if it's set)
Parameters
| $member |
name of the member variable
|
Returns
the variable value (if set), false otherwise
|
#
|
public
|
getUntil(): mixed
Returns when the event will go until - corresponds to UNTIL in RFC 2445.
Returns when the event will go until - corresponds to UNTIL in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
setUntil(string|int|DateTime $ts): void
Parameters
| $ts |
timestamp (int) / Valid DateTime format (string)
|
Throws
|
#
|
public
|
getCount(): mixed
Returns the count of the times the event will occur (should only appear if 'until'
does not appear) - corresponds to COUNT in RFC 2445.
Returns the count of the times the event will occur (should only appear if 'until'
does not appear) - corresponds to COUNT in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getInterval(): mixed
Returns the interval - corresponds to INTERVAL in RFC 2445.
Returns the interval - corresponds to INTERVAL in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getBySecond(): mixed
Returns the bysecond part of the event - corresponds to BYSECOND in RFC 2445.
Returns the bysecond part of the event - corresponds to BYSECOND in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByMinute(): mixed
Returns the byminute information for the event - corresponds to BYMINUTE in RFC 2445.
Returns the byminute information for the event - corresponds to BYMINUTE in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByHour(): mixed
Corresponds to BYHOUR in RFC 2445.
Corresponds to BYHOUR in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByDay(): mixed
Corresponds to BYDAY in RFC 2445.
Corresponds to BYDAY in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByMonthDay(): mixed
Corresponds to BYMONTHDAY in RFC 2445.
Corresponds to BYMONTHDAY in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByYearDay(): mixed
Corresponds to BYYEARDAY in RFC 2445.
Corresponds to BYYEARDAY in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByWeekNo(): mixed
Corresponds to BYWEEKNO in RFC 2445.
Corresponds to BYWEEKNO in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getByMonth(): mixed
Corresponds to BYMONTH in RFC 2445.
Corresponds to BYMONTH in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getBySetPos(): mixed
Corresponds to BYSETPOS in RFC 2445.
Corresponds to BYSETPOS in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|
public
|
getWkst(): mixed
Corresponds to WKST in RFC 2445.
Corresponds to WKST in RFC 2445.
Returns
string if the member has been set, false otherwise
|
#
|