Matukio Events for Joomla Documentation
Matukio Events Plugin Events
Matukio Events brings support for Joomla plugins and allows you to easily inject your own code and functions. If you are missing one just drop us a line!
See also Creating a Plugin for Joomla
Booking:
(Context = com_matukio.book)
onValidateBooking ($post, $event, $status)
$post contains the whole Post of the booking form as a reference.
$event the event object for which the booking is created.
$status the current validation status (not as reference) -> 0 = fail, 1 = okay, 2 = wait list
If you return an array with an "error" key the validation status changes to failed. The value is used as error message.
Please note that for administrators / organizers in the administrator area of Joomla all validation rules are ignored (just shown as warning).
onBeforeSaveBooking ($context, $booking, $event)
$booking contains the current booking object bound to the JTable object, before it is saved.
$event contains the event object for the booking.
Return values are ignored.
onAfterBookingSave ($booking, $event)
$booking contains the current booking (JTable object), after it is saved and checked in.
$event contains the event object for the booking.
Return values are ignored.
Event save:
(Context = com_matukio.event (mostly))
onBeforeSaveEvent ($context, $event, $post)
Params:
$context - Contains the context where this is called (event submission form or event edit etc.)
$event - contains the current (JTable bind) event before saving. Required fields have been already validated.
$post - The complete post of the event form
If you return an array with an "error" key the validation status changes to failed. The value is used as error message.
onAfterSaveEvent ($context, $event, $isNew)
Params:
$context - Contains the context where this is called (event submission form or event edit etc.)
$event is the saved and checked in event object.
$isNew is true when this is a newly created event, false when we edit an existing one.
Return values are ignored.
onAfterSaveRecurring ($context, $event, $isNew)
Triggered when a date is saved
Params:
$context - Contains the context where this is called (event submission form or event edit etc.)
$event is the saved and checked in event object.
$isNew is true when this is a newly created date, false when we edit an existing one.
Return values are ignored.
onEventAfterDelete ($context, $eventId)
Triggered when a date is saved
Params:
$context - Contains the context where this is called (event form or event edit etc.)
$eventId - The event Id (not date Id!)
Return values are ignored.
Event save:
onBeforeApiSubmit ($context, $result, $task)
Triggered when before the API result is send.
Params:
$context - com_matukio.api
$result - Result Array from the API request
$task - The task that was executed
Return values are ignored.
Single event presentation:
(Context = com_matukio.event)
onContentAfterDisplay ($context, $event, $params)
(Context = com_matukio.event)
The result is added after the event informations at the bottom. (See CComment for a sample)
$event - The event object (as reference)
$params - The menu params for this view
Upcoming events
onContentAfterDisplay ($context, $event, $params)
(Context = com_matukio.upcomingevent)
The result is added after the event short description. Called for every event, which is displayed.
$event - The event object (as reference)
$params - The menu params for this view
Featured events
onContentAfterDisplay ($context, $event, $params)
(Context = com_matukio.featured)
The result is added after the event short description. Called for every event, which is displayed.
$event - The event object (as reference)
$params - The menu params for this view
Location
onContentAfterDisplay ($context, $location, $params)
(Context = com_matukio.location)
Payment events (based on Techjoomla's common payment API)
onTP_GetInfo($paymentMethod)
Get the information on the payment method
onTP_GetHTML($vars)
Triggered to get the HTML of the payment plugin
onTP_Processpayment($post)
Triggered on processing the payment
