Load Order Details

public function onLoadAppointmentsOrderDetails(mixed &$query, int $id, mixed $langtag, array $options) : void

Fires while building the query used to fetch the details of the appointments.

Description

External plugins can attach to this hook in order to manipulate the query at runtime, in example to alter the default ordering.

Parameters

&$query

(mixed)  Either a query builder object or a string.

$id

(int)  The ID of the order.

$langtag

(string|null)  The language tag. If null, the default one will be used.

$options

(array)  An array of options to be passed to the order instance.

Return Value

None.

Example

/**
 * External plugins can attach to this hook in order to manipulate
 * the query at runtime, in example to alter the default ordering.
 *
 * @param   mixed    &$query   The query string or a query builder object.
 * @param   integer  $id       The ID of the order.
 * @param   mixed    $langtag  The language tag. If null, the default one will be used.
 * @param   array    $options  An array of options to be passed to the order instance.
 *
 * @return  void
 */
public function onLoadAppointmentsOrderDetails(&$query, $id, $langtag, $options)
{
    /**
     * @todo it is possible to manipulate here the query
     */
}

Changelog