Build Query

public function onBuildPackagesListQuery(mixed &$query, array $filters) : void

Fires while loading the packages to display.

Description

Trigger hook to manipulate at runtime the query used to load the items to display under the Packages List page in the front-end.

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.

$filters

(array)  An array of options to filter the packages.

• id_group - takes only the packages assigned to the specified group.

Return Value

None.

Example

The example below joins the packages table to a third-party table to access further data.

/**
 * Trigger hook to manipulate the query at runtime. Third party plugins
 * can extend the query by applying further conditions or selecting
 * additional data.
 *
 * @param   mixed  &$query   Either a query builder or a query string.
 * @param   array  $filters  An array of filters.
 *
 * @return  void
 */
public function onBuildPackagesListQuery(&$query, $filters)
{
    $dbo = JFactory::getDbo();

    // select some columns
    $query->select($dbo->qn(['tpt.column1', 'tpt.column2']));
    // join packages to a third-party table
    $query->leftjoin($dbo->qn('#__myplugin_third_party_table', 'tpt') . ' ON ' . $dbo->qn('tpt.id_package') . ' = ' . $dbo->qn('p.id'));
    // avoid duplicates
    $query->group($dbo->qn('p.id'));
}

Changelog