Fetch Compatible

public function onFetchCompatibleMailTexts(mixed &$query, mixed $order, array $options) : void

Fires while loading the custom texts to include within the e-mail.

Description

Trigger hook to allow the plugins to manipulate the query used to retrieve the available mail custom texts.

Third party plugins can extend the query by applying further conditions or selecting additional data.

Parameters

&$query

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

$order

(VAPOrderAppointment)  An object holding the appointment(s) details.

$options

(array)  An array of options to filter the custom texts.

• lang - the language tag to use;
• file - the template file to look for;
• id - either an ID or a list of custom texts;
• default - true to load the default custom fields, false to use only the specified ID.

Return Value

None.

Example

/**
 * Trigger hook to allow the plugins to manipulate the query used to retrieve
 * the available mail custom texts.
 *
 * @param   mixed  &$query   Either a query builder or a query string.
 * @param   mixed  $order    An object containing the order details.
 * @param   array  $options  An array of options.
 *
 * @return  void
 */
public function onFetchCompatibleMailTexts(&$query, $order, $options)
{
    /**
     * @todo it is possible to manipulate here the query
     */
}

Changelog