===== Filter =====

The Filter class is used to filter the data that is fetched from a table. Filters are used in the [[vortex::gui|GUI]] to filter rows shown in the [[vortex:showlist|ShowList]]. Filters created in the GUI can be used in the API by supplying the Filter class constructor with the ID of the specific Filter.

==== Extends ====
[[vortex:tablestub|TableStub]]

==== Implements ====
[[vortex:initializable|Initializable]]

==== Constants ====

==== Methods ====

==== Code Examples ====
This example creates a new filter and fetches 100 records from the table //Testtable// having //ShowMe// = 'Yes'
<code php>
$filter = new Filter();
$filter->addRule( 'Testtable', 'ShowMe', FilterRule::EQUALS, 'Yes' );
$filter->getTableRecords( 'Testtable' );
</code>

This examples uses the filter created above to return the number of rows matched:
<code php>
$cnt = $filter->getRecordsCount( 'Testtable' );
</code>