php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-03 05:48:11 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update LikeCondition::setEscapingReplacements() phpdoc (#19830)

Browse Source
This commit is contained in:
Robert Korulczyk
2023-05-09 08:52:41 +02:00
committed by GitHub
parent 4e7aac710f
commit 400df717e4
1 changed files with 7 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
framework/db/conditions/LikeCondition.php
View File

@ -18,8 +18,8 @@ use yii\base\InvalidArgumentException;
class LikeCondition extends SimpleCondition class LikeCondition extends SimpleCondition
{ {
/** /**
* @var array|null|false map of chars to their replacements, false if characters should not be escaped * @var 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. * or either `null` or empty array if escaping is condition builder responsibility.
* By default it's set to `null`. * By default it's set to `null`.
*/ */
protected $escapingReplacements; protected $escapingReplacements;
@ -40,9 +40,10 @@ class LikeCondition extends SimpleCondition
/** /**
* This method allows to specify how to escape special characters in the value(s). * This method allows to specify how to escape special characters in the value(s).
* *
* @param array an array of mappings from the special characters to their escaped counterparts. * @param array|null|false an array of mappings from the special characters to their escaped counterparts.
* You may use `false` or an empty array to indicate the values are already escaped and no escape * You may use `false` to indicate the values are already escaped and no escape should be applied,
* should be applied. Note that when using an escape mapping (or the third operand is not provided), * 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. * the values will be automatically enclosed within a pair of percentage characters.
*/ */
public function setEscapingReplacements($escapingReplacements) public function setEscapingReplacements($escapingReplacements)
@ -51,7 +52,7 @@ class LikeCondition extends SimpleCondition
} }
/** /**
* @return array|false * @return array|null|false
*/ */
public function getEscapingReplacements() public function getEscapingReplacements()
{ {