Documentation

Event

in package

• SMF

implements ArrayAccess uses ArrayAccessHelper

Represents a (possibly recurring) calendar event.

Table of Contents

Interfaces

ArrayAccess

Constants

TYPE_BIRTHDAY  = 2

TYPE_EVENT  = 0

TYPE_HOLIDAY  = 1

Properties

$adjustments  : array<string|int, mixed>

$allday  : bool

$board  : int

$byday_items  : array<string|int, mixed>

$byday_num_options  : array<string|int, mixed>

$duration  : TimeInterval

$frequency_units  : array<string|int, mixed>

$groups  : array<string|int, mixed>

$id  : int

$id_first  : string

$loaded  : array<string|int, mixed>

$location  : string

$member  : int

$modified_time  : int

$msg  : int

$name  : string

$recurrence_iterator  : RecurrenceIterator

$rrule_presets  : array<string|int, mixed>

$selected_occurrence  : EventOccurrence

$sorted_weekdays  : array<string|int, mixed>

$special_rrule  : array<string|int, mixed>

$special_rrules  : array<string|int, mixed>

$start  : Time

$title  : string

$topic  : int

$type  : int

$uid  : string

$enabled  : bool

$exdates  : array<string|int, mixed>

$prop_aliases  : array<string|int, mixed>

$rdates  : array<string|int, mixed>

$rrule  : string

$sequence  : int

$use_permissions  : bool

$view_end  : DateTimeImmutable

$view_start  : DateTimeImmutable

Methods

__construct()  : mixed

Constructor.

__get()  : mixed

Gets custom property values.

__isset()  : bool

Checks whether a custom property has been set.

__set()  : void

Sets custom properties.

addOccurrence()  : void

Adds an arbitrary date to the recurrence set.

changeUntil()  : void

Updates the RRule to set a new UNTIL date.

constructFromICal()  : array<string|int, mixed>

Constructs instances of this class from iCalendar data.

create()  : void

Creates an event and saves it to the database.

export()  : string

Builds iCalendar components for events, including recurrence info.

foldICalLine()  : string

Folds lines of text to fit within the iCalendar line width restraint.

get()  : Generator<string|int, Event>

Generator that yields instances of this class.

getAllVisibleOccurrences()  : Generator<string|int, EventOccurrence>

Returns a generator that yields all occurrences of the event between $this->view_start and $this->view_end.

getFirstOccurrence()  : EventOccurrence|false

Gets the first occurrence of the event.

getLastOccurrence()  : EventOccurrence|false

Gets the last occurrence of the event.

getOccurrence()  : EventOccurrence|false

Gets an occurrence of the event by its recurrence ID.

getOccurrencesInRange()  : Generator<string|int, EventOccurrence>

Gets events within the given date range, and returns a generator that yields all occurrences of those events within that range.

getRecurrenceEnd()  : Time

Gets the date after which no more occurrences happen.

getUpcomingOccurrence()  : EventOccurrence|false

Gets the next occurrence of the event after the date given by $when.

import()  : array<string|int, mixed>

Imports events from iCalendar data and saves them to the database.

load()  : array<string|int, mixed>

Loads an event by ID number or by topic ID.

modify()  : void

Modifies an event.

offsetExists()  : bool

Checks whether a property has been set when object is accessed as an array.

offsetGet()  : mixed

Gets properties when object is accessed as an array.

offsetSet()  : void

Sets properties when object is accessed as an array.

offsetUnset()  : void

Unsets properties when object is accessed as an array.

remove()  : void

Removes an event.

removeOccurrence()  : void

Removes a date from the recurrence set.

save()  : void

Saves this event to the database.

setRequestedStartAndDuration()  : void

Set the start and end dates and times for a posted event for insertion into the database.

createOccurrence()  : EventOccurrence

Creates an EventOccurrence object for the given start time.

createRecurrenceIterator()  : bool

Sets $this->recurrence_iterator, but only if all necessary properties have been set.

handleSpecialRRule()  : void

Some holidays have special values in the 'rrule' field in the database.

queryData()  : Generator<string|int, array<string|int, mixed>>

Generator that runs queries about event data and yields the result rows.

setRequestedRDatesAndExDates()  : void

Set the RDates for a posted event for insertion into the database.

setRequestedRRule()  : void

Set the RRule for a posted event for insertion into the database.

standardizeEventOptions()  : array<string|int, mixed>

Standardizes various forms of input about start and end times.