0 follower

Final Class Yiisoft\Data\Reader\Filter\Like

All Classes | Properties | Methods
InheritanceYiisoft\Data\Reader\Filter\Like
ImplementsYiisoft\Data\Reader\FilterInterface

Like filter defines a criteria for ensuring field value is like-match to a given value.

Public Properties

Hide inherited properties

Property Type Description Defined By
$caseSensitive boolean|null Yiisoft\Data\Reader\Filter\Like
$field string Yiisoft\Data\Reader\Filter\Like
$mode \Yiisoft\Data\Reader\Filter\LikeMode Yiisoft\Data\Reader\Filter\Like
$value string|\Stringable Yiisoft\Data\Reader\Filter\Like

Public Methods

Hide inherited methods

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

Property Details

Hide inherited properties

$caseSensitive public property
public boolean|null $caseSensitive = null
$field public property
public string $field = null
$mode public property
public \Yiisoft\Data\Reader\Filter\LikeMode $mode = LikeMode::Contains
$value public property
public string|\Stringable $value = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string $field, string|\Stringable $value, boolean|null $caseSensitive = null, \Yiisoft\Data\Reader\Filter\LikeMode $mode = LikeMode::Contains )
$field string

Name of the field to compare.
$value string|\Stringable

Value to like-compare with.
$caseSensitive boolean|null

Whether search must be case-sensitive:

  • null - depends on implementation;
  • true - case-sensitive;
  • false - case-insensitive.
$mode \Yiisoft\Data\Reader\Filter\LikeMode

Matching mode.

 

                public function __construct(
    public readonly string $field,
    public readonly string|Stringable $value,
    public readonly ?bool $caseSensitive = null,
    public readonly LikeMode $mode = LikeMode::Contains,
) {}