public function onAfterListQueryExportCSV(array &$rows, mixed $options) : void

Fires before returning the array of appointments to export.


Description

Trigger hook to allow the plugins to manipulate the response fetched by 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

&$rows

(array)  An array of results (objects).

$options

(JObject)  A registry of options. This instance holds the values of the settings specified by the export driver, such as the delimiter character.

Return Value

None.


Example

/**
 * Trigger hook to allow the plugins to manipulate response fetched by
 * the query used to retrieve a standard list of records.
 *
 * @param   mixed  &$rows    An array of results (objects).
 * @param   mixed  $options  A configuration registry.
 *
 * @return  void
 */
public function onAfterListQueryExportCSV(&$rows, $options)
{
    /**
     * @todo it is possible to manipulate here the export rows
     */
}

Changelog

VersionDescription
1.7 Introduced.
Last Update: 2021-10-08 09:59
Helpful?