Skip to content
PHP Ecosystem
Explore

LikeConditionBuilder

API reference › yii › db › conditions › LikeConditionBuilder

classyii\db\conditions\LikeConditionBuilder
Implementsyii\db\ExpressionBuilderInterface
Uses traitsyii\db\ExpressionBuilderTrait
Since2.0.14
Sourceframework/db/conditions/LikeConditionBuilder.php
3 subclasses

Class LikeConditionBuilder builds objects of LikeCondition

PropertyTypeDescriptionDefined by
$escapeCharacter protectedstring|nullCharacter used to escape special characters in LIKE conditions. Default: null.LikeConditionBuilder
$escapingReplacements protectedarrayMap of chars to their replacements in LIKE conditions. Default: ['%' => '\%', '_' => '\_', '\\' => '\\\\'].LikeConditionBuilder
$queryBuilder protectedyii\db\QueryBuilderDefault: null.yii\db\ExpressionBuilderTrait
MethodDescriptionDefined by
__construct()ExpressionBuilderTrait constructor.yii\db\ExpressionBuilderTrait
build()Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.LikeConditionBuilder
parseOperator() protectedLikeConditionBuilder
protected string|null $escapeCharacter = null

Character used to escape special characters in LIKE conditions.

By default it’s assumed to be \.

protected array $escapingReplacements = ['%' => '\%', '_' => '\_', '\\' => '\\\\']

Map of chars to their replacements in LIKE conditions.

By default it’s configured to escape %, _ and \ with \.

public function build(yii\db\ExpressionInterface|yii\db\conditions\LikeCondition $expression, array &$params = []): string

Method builds the raw SQL from the $expression that will not be additionally escaped or quoted.

Parameters

ParameterTypeDescription
$expressionyii\db\ExpressionInterface|LikeConditionThe expression to be built.
$paramsarrayThe binding parameters.

Returns

string: The raw SQL that will not be additionally escaped or quoted.

protected function parseOperator(string $operator): array

Parameters

ParameterTypeDescription
$operatorstring

Returns

array