interface RepetitionInterface implements JsonSerializable (View source)

Constants

REPEAT_NONE

Repeat constants.

REPEAT_DAILY

REPEAT_WEEKLY

REPEAT_MONTHLY

MONTHLY_REPEAT_WEEKLY

Monthly repeat constants.

MONTHLY_REPEAT_MONTHLY

MONTHLY_REPEAT_LAST_WEEKDAY

Methods

getTimezone()

No description

setTimezone(DateTimeZone $timezone)

No description

int|string|null
getID()

The ID of this repetition, null for unsaved.

getStartDateTimestamp()

Returns the start date/time as a timestamp

setStartDate($start_date)

Set the start date.

setEndDate($end_date)

Set the end date.

setStartDateAllDay(bool $start_date_all_day)

Toggle whether start_date is all day.

setEndDateAllDay(bool $end_date_all_day)

Toggle whether end_date is all day.

setRepeatPeriod($repeat_period)

No description

mixed
setRepeatPeriodWeekDays($repeat_period_week_days)

No description

mixed
setRepeatEveryNum($repeat_every_num)

No description

mixed
setRepeatMonthBy(int $repeat_month_by)

No description

mixed
setRepeatPeriodEnd($repeat_period_end)

No description

mixed
getStartDate()

No description

bool
isStartDateAllDay()

No description

bool
isEndDateAllDay()

No description

mixed
getEndDate()

No description

mixed
repeats()

No description

mixed
getRepeatPeriod()

No description

mixed
getRepeatPeriodWeekDays()

No description

int
getRepeatMonthBy()

No description

int
getRepeatEveryNum()

No description

string
getRepeatPeriodEnd()

No description

mixed
isActive($now = null)

No description

mixed
getTextRepresentation()

No description

array[]
activeRangesBetween(int $start, int $end)

Get all active time slots that start within two time periods.

Details

getTimezone()

setTimezone(DateTimeZone $timezone)

Parameters

DateTimeZone $timezone

int|string|null getID()

The ID of this repetition, null for unsaved.

Return Value

int|string|null

getStartDateTimestamp()

Returns the start date/time as a timestamp

setStartDate($start_date)

Set the start date.

Parameters

$start_date

setEndDate($end_date)

Set the end date.

Parameters

$end_date

setStartDateAllDay(bool $start_date_all_day)

Toggle whether start_date is all day.

Parameters

bool $start_date_all_day

setEndDateAllDay(bool $end_date_all_day)

Toggle whether end_date is all day.

Parameters

bool $end_date_all_day

setRepeatPeriod($repeat_period)

Parameters

$repeat_period

mixed setRepeatPeriodWeekDays($repeat_period_week_days)

Parameters

$repeat_period_week_days

Return Value

mixed

mixed setRepeatEveryNum($repeat_every_num)

Parameters

$repeat_every_num

Return Value

mixed

mixed setRepeatMonthBy(int $repeat_month_by)

Parameters

int $repeat_month_by [ ::MONTHLY_REPEAT_WEEKLY | ::MONTHLY_REPEAT_MONTHLY ]

Return Value

mixed

mixed setRepeatPeriodEnd($repeat_period_end)

Parameters

$repeat_period_end

Return Value

mixed

mixed getStartDate()

Return Value

mixed

bool isStartDateAllDay()

Return Value

bool

bool isEndDateAllDay()

Return Value

bool

mixed getEndDate()

Return Value

mixed

mixed repeats()

Return Value

mixed

mixed getRepeatPeriod()

Return Value

mixed

mixed getRepeatPeriodWeekDays()

Return Value

mixed

int getRepeatMonthBy()

Return Value

int self::MONTHLY_REPEAT_* enum [ ::MONTHLY_REPEAT_WEEKLY | ::MONTHLY_REPEAT_MONTHLY ]

int getRepeatEveryNum()

Return Value

int

string getRepeatPeriodEnd()

Return Value

string

mixed isActive($now = null)

Parameters

$now

Return Value

mixed

mixed getTextRepresentation()

Return Value

mixed

array[] activeRangesBetween(int $start, int $end)

Get all active time slots that start within two time periods.

Parameters

int $start
int $end

Return Value

array[]