Reference

Event

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

Properties

id

The ID of the event.

title

The event’s title.

url

The URL to this single event.

type

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

typeId

The ID of the event’s type.

status

The current status of the event, which is live, pending, expired or disabled. An enabled event is pending before its post date, expired after its expiry date and live in between.

enabled

Whether the event is enabled (true or false).

capacity

The total capacity of tickets available for this event.

startDate

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

endDate

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

postDate

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

expiryDate

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

Methods

getCpEditUrl()

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

getSessions()

Returns a collection of Session objects associated with this event.

getTicketTypes()

Returns a collection of TicketType objects associated with this event.

getTickets()

Returns a collection of Ticket objects generated for this event.

getAvailableTickets()

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 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 whether the event has any tickets available for purchase. This is false when none of its tickets are available, such as when the event is sold out or not on sale.