Reference

Event

Whenever you’re dealing with an event in your template, you’re actually working with a Event object.

Properties

id

Type: int|null

The ID of the event.

title

Type: string|null

The event’s title.

url

Type: string|null

The URL to this single event.

type

Type: verbb\events\models\EventType

The event’s type (as defined by its event type).

typeId

Type: int|null

The ID of the event’s type.

status

Type: string|null

The current status of the event: live, pending, or expired, determined based on startDate, endDate, postDate, and expiryDate.

enabled

Type: bool

Whether the event is enabled (true or false).

capacity

Type: int|null

The total capacity of tickets available for this event.

startDate

Type: DateTime|null

The start date of the event (based on the first session).

endDate

Type: DateTime|null

The end date of the event (based on the last session).

postDate

Type: DateTime|null

The date when this event becomes available (i.e., when it’s posted).

expiryDate

Type: DateTime|null

The date after which this event will no longer be available.

Methods

getCpEditUrl()

Returns: string|null

Returns the URL to edit this event in the control panel.

getSessions()

Returns: verbb\events\elements\SessionCollection

Returns a collection of Session objects associated with this event.

getTicketTypes()

Returns: verbb\events\elements\TicketTypeCollection

Returns a collection of TicketType objects associated with this event.

getTickets()

Returns: verbb\events\elements\TicketCollection

Returns a collection of Ticket objects generated for this event.

getAvailableTickets()

Returns: verbb\events\elements\TicketCollection

Returns a collection of available Ticket objects for sale. This respects the 'Available From/To' dates, along with ticket capacity and sales status.

getIcsUrl()

Returns: string

Returns a URL to download the ICS (iCalendar) file for this single event. For multi-session events this spans all sessions; use Session::getIcsUrl() for a specific session.

getIsAvailable()

Returns: bool

Indicates if the event is available for purchase. This will be false if there are no tickets available for sale, meaning the event is completely sold out.

Last updated: Sept 14, 2026, 8:30:19 PM