0 follower

Abstract Class Yiisoft\Data\Reader\Filter\Compare

All Classes | Properties | Methods

Inheritance	Yiisoft\Data\Reader\Filter\Compare
Implements	Yiisoft\Data\Reader\FilterInterface
Subclasses	Yiisoft\Data\Reader\Filter\Equals, Yiisoft\Data\Reader\Filter\GreaterThan, Yiisoft\Data\Reader\Filter\GreaterThanOrEqual, Yiisoft\Data\Reader\Filter\LessThan, Yiisoft\Data\Reader\Filter\LessThanOrEqual

Compare filter is a base class that defines a criteria for comparing field value with a given value.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$field	string		Yiisoft\Data\Reader\Filter\Compare
$value	boolean\|DateTimeInterface\|float\|integer\|string\|\Stringable		Yiisoft\Data\Reader\Filter\Compare

Public Methods

Hide inherited methods

Method	Description	Defined By
__construct()		Yiisoft\Data\Reader\Filter\Compare
withValue()		Yiisoft\Data\Reader\Filter\Compare

Property Details

Hide inherited properties

$field public property

public string $field = null

$value public property

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string $field, boolean\|DateTimeInterface\|float\|integer\|string\|\Stringable $value )
$field	string	Name of the field to compare.
$value	boolean\|DateTimeInterface\|float\|integer\|string\|\Stringable	Value to compare to.

Source code

                final public function __construct(
    public readonly string $field,
    public readonly bool|DateTimeInterface|float|int|string|Stringable $value,
) {}

withValue() public method

public Yiisoft\Data\Reader\Filter\Compare withValue ( boolean\|DateTimeInterface\|float\|integer\|string\|\Stringable $value )
$value	boolean\|DateTimeInterface\|float\|integer\|string\|\Stringable	Value to compare to.

Source code

                final public function withValue(bool|DateTimeInterface|float|int|string|Stringable $value): static
{
    return new static($this->field, $value);
}