0 follower

Class yii\db\conditions\LikeCondition

All Classes | Properties | Methods
Inheritanceyii\db\conditions\LikeCondition » yii\db\conditions\SimpleCondition
Implementsyii\db\conditions\ConditionInterface
Available since version2.0.14
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/conditions/LikeCondition.php

Class LikeCondition represents a LIKE condition.

Protected Properties

Hide inherited properties

Property Type Description Defined By
$escapingReplacements array|null|false Map of chars to their replacements, false if characters should not be escaped or either null or empty array if escaping is condition builder responsibility. yii\db\conditions\LikeCondition

Public Methods

Hide inherited methods

Method Description Defined By
__construct() yii\db\conditions\LikeCondition
fromArrayDefinition() Creates object by array-definition as described in Query Builder – Operator format guide article. yii\db\conditions\LikeCondition
getColumn() yii\db\conditions\SimpleCondition
getEscapingReplacements() yii\db\conditions\LikeCondition
getOperator() yii\db\conditions\SimpleCondition
getValue() yii\db\conditions\SimpleCondition
setEscapingReplacements() This method allows to specify how to escape special characters in the value(s). yii\db\conditions\LikeCondition

Property Details

Hide inherited properties

$escapingReplacements protected property

Map of chars to their replacements, false if characters should not be escaped or either null or empty array if escaping is condition builder responsibility. By default it's set to null.

protected array|null|false $escapingReplacements = null

Method Details

Hide inherited methods

__construct() public method

public mixed __construct ( string $column, string $operator, string[]|string $value )
$column string

The column name.
$operator string

The operator to use (e.g. LIKE, NOT LIKE, OR LIKE or OR NOT LIKE)
$value string[]|string

Single value or an array of values that $column should be compared with. If it is an empty array the generated expression will be a false value if operator is LIKE or OR LIKE and empty if operator is NOT LIKE or OR NOT LIKE.

 

                public function __construct($column, $operator, $value)
{
    parent::__construct($column, $operator, $value);
}
fromArrayDefinition() public static method

Creates object by array-definition as described in Query Builder – Operator format guide article.

public static static fromArrayDefinition ( mixed $operator, mixed $operands )
$operator mixed

Operator in uppercase.
$operands mixed

Array of corresponding operands
throws yii\base\InvalidArgumentException

if wrong number of operands have been given.

 

                public static function fromArrayDefinition($operator, $operands)
{
    if (!isset($operands[0], $operands[1])) {
        throw new InvalidArgumentException("Operator '$operator' requires two operands.");
    }
    $condition = new static($operands[0], $operator, $operands[1]);
    if (isset($operands[2])) {
        $condition->escapingReplacements = $operands[2];
    }
    return $condition;
}
getColumn() public method

Defined in: yii\db\conditions\SimpleCondition::getColumn()

public mixed getColumn ( )

                public function getColumn()
{
    return $this->column;
}
getEscapingReplacements() public method

public array|null|false getEscapingReplacements ( )

                public function getEscapingReplacements()
{
    return $this->escapingReplacements;
}
getOperator() public method

Defined in: yii\db\conditions\SimpleCondition::getOperator()

public string getOperator ( )

                public function getOperator()
{
    return $this->operator;
}
getValue() public method

Defined in: yii\db\conditions\SimpleCondition::getValue()

public mixed getValue ( )

                public function getValue()
{
    return $this->value;
}
setEscapingReplacements() public method

This method allows to specify how to escape special characters in the value(s).

public mixed setEscapingReplacements ( array|null|false $escapingReplacements )
$escapingReplacements array|null|false

An array of mappings from the special characters to their escaped counterparts. You may use false to indicate the values are already escaped and no escape should be applied, or either null or empty array if escaping is condition builder responsibility. Note that when using an escape mapping (or the third operand is not provided), the values will be automatically enclosed within a pair of percentage characters.

 

                public function setEscapingReplacements($escapingReplacements)
{
    $this->escapingReplacements = $escapingReplacements;
}