Your cart is empty!
Before List Query
public function onBeforeListQueryExportICS(mixed &$query, mixed $options) : void
Fires while building the query used to fetch the appointments to export.
Description
Trigger hook to allow the plugins to manipulate the query used to retrieve a standard list of records.
It is possible to use $options->get($key)
to access the internal properties of the options argument.
Parameters
- &$query
-
(mixed) Either a query builder object or a string.
- $options
-
(JObject) A registry of options. This instance holds the values of the settings specified by the export driver, such as the reminder option.
Return Value
None.
Example
/**
* Trigger event to allow the plugins to manipulate the query used to retrieve
* a standard list of records.
*
* @param mixed &$query The query string or a query builder object.
* @param mixed $options A configuration registry.
*
* @return void
*/
public function onBeforeListQueryExportICS(&$query, $options)
{
/**
* @todo it is possible to manipulate here the query
*/
}
Changelog
Version | Description |
---|---|
1.6.6 | Introduced. |
Last Update: 2021-10-08 10:15
Helpful?