0 follower

Interface Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface

All Classes | Methods
Implemented byYiisoft\Data\Reader\Iterable\FilterHandler\AllHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\AndXHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\BetweenHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsNullHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanOrEqualHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\InHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\LessThanHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\LessThanOrEqualHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\LikeHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\NoneHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\NotHandler, Yiisoft\Data\Reader\Iterable\FilterHandler\OrXHandler

Iterable filter handler checks whether an item matches criteria defined in the filter with the same operator.

Public Methods

Hide inherited methods

Method Description Defined By
getFilterClass() Get matching filter class name. Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface
match() Check whether an item matches iterable filter handlers for the filters with matching operator active. Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface

Method Details

Hide inherited methods

getFilterClass() public abstract method

Get matching filter class name.

If the filter is active, a corresponding handler will be used during matching.

public abstract string getFilterClass ( )
return string

The filter class name.

 

                public function getFilterClass(): string;
match() public abstract method

Check whether an item matches iterable filter handlers for the filters with matching operator active.

public abstract boolean match ( array|object $item, Yiisoft\Data\Reader\FilterInterface $filter, Yiisoft\Data\Reader\Iterable\Context $context )
$item array|object

Item to check.
$filter Yiisoft\Data\Reader\FilterInterface

Matched filter.
$context Yiisoft\Data\Reader\Iterable\Context
return boolean

Whether item matches the filter.

 

                public function match(array|object $item, FilterInterface $filter, Context $context): bool;