Marcz\Search\Traits\Filterables
Synopsis
trait Filterables
{
- // methods
- public bool canFilterBy()
- public Filterable filter()
- public Filterables filterAny()
- public Filterable exclude()
- public Filterable filterByCallback()
- public mixed byID()
- public SS_List byIDs()
Methods
public
- byID() — Return the first item with the given ID
- byIDs() — Filter this list to only contain the given Primary IDs
- canFilterBy() — Returns TRUE if the list can be filtered by a given field expression.
- exclude() — Return a new instance of this list that excludes any items with these charactaristics
- filter() — Return a new instance of this list that only includes items with these charactaristics
- filterAny() — Return a copy of this list which contains items matching any of these charactaristics.
- filterByCallback() — Return a new instance of this list that excludes any items with these charactaristics Filter this List by a callback function. The function will be passed each record of the List in turn, and must return true for the record to be included. Returns the filtered list.