Filter Interfaces

The filter interfaces provide access to filters and filter rules defined in the backend within a MetaModel.

In addition, further filters can be created programmatically or filter parameters can be set.

IFilterRule Interface

Current information at: IFilterRule

Interfaces:

getMatchingIds()
returns all IDs matching the given filter rule

IFilter Interface

Current information at: IFilter

Interfaces:

addFilterRule(IFilterRule $objFilterRule)
adds a filter rule to the filter chain

getMatchingIds()
returns all IDs matching the given filter rule

createCopy()
creates a copy of the filter

Examples

The “filtering” blocks between “Start” and “End” are alternatives to each other. The called classes should be imported with a qualified “use” statement.

<?php
// Start
$modelName = 'mm_employees';
$factory   = \Contao\System::getContainer()->get('metamodels.factory');
// alternatively
//$factory = $this->getContainer()->get('metamodels.factory');
$model  = $factory->getMetaModel($modelName);
$filter = $model->getEmptyFilter();

// Filter by fixed ID (list):
$idList = [1,2,3];
$filter->addFilterRule(new \MetaModels\Filter\Rules\StaticIdList($idList));

// Filter by attribute value:
$value      = 'marketing';
$languages  = $model->getAvailableLanguages();
$attribute  = $model->getAttribute('division');
$filter->addFilterRule(new \MetaModels\Filter\Rules\SearchAttribute($attribute, $value, $languages));

// Custom SQL:
$query = \sprintf('SELECT * FROM %s WHERE published = 1', $modelName);
$filter->addFilterRule(new \MetaModels\Filter\Rules\SimpleQuery($query));
// Alternative see https://www.doctrine-project.org/projects/doctrine-dbal/en/4.2/reference/data-retrieval-and-manipulation.html
$query = \sprintf('SELECT * FROM %s WHERE published = ?', $modelName);
$filter->addFilterRule(new \MetaModels\Filter\Rules\SimpleQuery($query, [1]));

// Filter with multiple rules:
// Combine with ConditionAnd() or ConditionOr()
// Comparison with GreaterThan, LessThan, NotEqual possible
$attribute        = $model->getAttribute('price');
$compareInclusive = true;
$andRule          = new \MetaModels\Filter\Rules\Condition\ConditionAnd();
$andRule
    ->addRule(new \MetaModels\Filter\Rules\Comparing\GreaterThan($attribute, 10, $compareInclusive)) // >= 10
    ->addRule(new \MetaModels\Filter\Rules\Comparing\LessThan($attribute, 20));                      // < 20
$filter->addFilterRule($andRule);

// End
$items    = $model->findByFilter($filter);
$arrItems = $items->parseAll('text');
//dump($arrItems);