Класс yii\db\Expression
| Наследование | yii\db\Expression » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/Expression.php |
Expression представляет выражение БД, которое не требует экранирования или кавычек.
Когда объект Expression встраивается в SQL-запрос или фрагмент, он будет заменён значением свойства $expression без экранирования или кавычек БД. Например,
$expression = new Expression('NOW()');
$now = (new \yii\db\Query)->select($expression)->scalar(); // SELECT NOW();
echo $now; // prints the current date
Объекты Expression преимущественно используются для передачи выражений SQL в методы yii\db\Query, yii\db\ActiveQuery и связанных классов.
Выражение также может быть связано с параметрами, указанными через $params.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $expression | string | Выражение БД | yii\db\Expression |
| $params | array | Список параметров, которые должны быть привязаны для этого выражения. | yii\db\Expression |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\db\Expression |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __toString() | Магический метод строки | yii\db\Expression |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли читать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
Подробное описание свойств
$expression публичное свойство
Выражение БД
public string $expression = null
$params публичное свойство
Список параметров, которые должны быть привязаны к этому выражению. Ключи — это заполнитель, появляющийся в $expression, а значения — соответствующие значения параметров.
public array $params = []
Подробное описание методов
__construct() публичный метод
Конструктор.
| public void __construct ( $expression, $params = [], $config = [] ) | ||
|---|---|---|
| $expression | string |
Выражение БД |
| $params | array |
Параметры |
| $config | array |
Пара имя-значение, которые будут использованы для инициализации свойств объекта |
__toString() публичный метод
Магический метод строки
| public string __toString ( ) | ||
|---|---|---|
| return | string |
Выражение БД |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-db-expression.html
