Events
Use this API to create, update and delete marketing events.
Methods
Invoke via \Components\Marketing\Events::method()
Click a method name to copy it.
Is the specified contact allowed to RSVP for the specified Event
The Attendee table contains all custom fields for all events, but specific events make use of different columns. Return the relevent custom fields for a particular Event.
Return
Rows in the configuration custom fields table.
Returns true if the event has available capacity.
If the event is unrestricted or has no capacity set, it will return true.
Returns true if the RSVP deadline for the given event has passed
Gets an event entity from a URI suffix (e.g. my-event)
Generates the SEO search description from event content
Generates SEO keywords from event content
Generates a unique URI suffix by cycling through formats until no collision
Generates the page URI suffix (SEO slug URI for the event)
Gets a record from the database
Parameters:
- $iEventId
int unsigned
A record's event_id
Return a set of records from the database
Return all the marketing_events that belong to specific categories.
Return all the current events that a contact is attending.
Return all of the current events that a contact is attending.
Gets a single field from a record
Parameters:
- $iEventId
int unsigned
A record's event_id
Returns the number of records in the database (matching the filter if specified)
Returns the current event if the current page is an event page, or null otherwise
Return
The event entity if on an event page, null otherwise
If the event is associated with a product, return the price of the product.
Returns the public URL for an event's success page
Returns the public URL for an event's RSVP form page
Retrieves an event from its page URI
Retrieves the event corresponding to an event product
Deletes a record from the database
Parameters:
- $iEventId
int unsigned
A record's event_id
Return
Returns true if record existed and was deleted, otherwise false
Returns the public URL path for events (e.g. /events-rsvp/)
Returns the available URL format patterns for event URI generation
Return
Array of format strings
Gets the event that has a colliding URI suffix, or null if available
Return
The colliding event, or null if suffix is available
Is the specified contact allowed to be added to the specified Event
Return
Return true if allowed, false if not.
Return true if the specified contact is registered to attend the specified event.
Is the specified contact allowed to be added to the specified Event
Return
Return true if allowed, false if not.
Return the event date with the format: (On the same day) 1 Sep 2016 2:00pm - 4:00pm. (Different day) 1 Sep 2016 2:00pm - 3 Sep 2016 3:00pm.
Render the price of an event, if it has one.
Return $iTime formatted into a human-readable string, in the timezone specified for this event.
Saves a record into the database
Saves a specific column of a row into a database
Parameters:
- $iEventId
int unsigned
A record's event_id
Return
Array of
Events that match the search query.
Determines if a URI suffix for a given entity is available
