Event#

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

Attributes#

AttributeDescription
idThe ID of the event.
titleThe event’s title.
urlThe URL to this single event.
typeThe event’s type (as defined by its event type).
typeIdThe ID of the event’s type.
statusThe current status of the event: live, pending, or expired, determined based on startDate, endDate, postDate, and expiryDate.
enabledWhether the event is enabled (true or false).
isAvailableIndicates 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.
capacityThe total capacity of tickets available for this event.
startDateThe start date of the event (based on the first session).
endDateThe end date of the event (based on the last session).
postDateThe date when this event becomes available (i.e., when it’s posted).
expiryDateThe date after which this event will no longer be available.

Methods#

MethodDescription
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.

Previous ← Purchased Ticket Queries Next Session →