Класс yii\sphinx\ColumnSchema
| Наследование | yii\sphinx\ColumnSchema » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно начиная с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-sphinx/blob/master/ColumnSchema.php |
Класс ColumnSchema описывает метаданные столбца в индексе Sphinx.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $dbType | строка | Тип базы данных этого столбца. | yii\sphinx\ColumnSchema |
| $isAttribute | булево | Является ли этот столбец атрибутом. | yii\sphinx\ColumnSchema |
| $isField | булево | Является ли этот столбец индексированным полем. | yii\sphinx\ColumnSchema |
| $isMva | булево | Является ли этот столбец атрибутом с множественными значениями (MVA). | yii\sphinx\ColumnSchema |
| $isPrimaryKey | булево | Является ли этот столбец первичным ключом. | yii\sphinx\ColumnSchema |
| $name | строка | Имя этого столбца (без кавычек). | yii\sphinx\ColumnSchema |
| $phpType | строка | Тип PHP этого столбца. | yii\sphinx\ColumnSchema |
| $type | строка | Абстрактный тип этого столбца. | yii\sphinx\ColumnSchema |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| dbTypecast() | Преобразует входное значение в соответствии с $type и $dbType для использования в запросе к базе данных. | yii\sphinx\ColumnSchema |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| phpTypecast() | Преобразует входное значение в соответствии с $phpType после извлечения из базы данных. | yii\sphinx\ColumnSchema |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| typecast() | Преобразует входное значение в соответствии с $phpType после извлечения из базы данных. | yii\sphinx\ColumnSchema |
Подробное описание свойств
$dbType общественное свойство
Тип столбца в базе данных. Возможные типы зависят от СУБД.
public string $dbType = null
$isAttribute общественное свойство
Является ли этот столбец атрибутом
public boolean $isAttribute = null
$isField общественное свойство
Является ли этот столбец индексированным полем
public boolean $isField = null
$isMva общественное свойство
Является ли этот столбец атрибутом с несколькими значениями (MVA)
public boolean $isMva = null
$isPrimaryKey общественное свойство
Является ли этот столбец первичным ключом
public boolean $isPrimaryKey = null
$name общественное свойство
Имя этого столбца (без кавычек).
public string $name = null
$phpType общественное свойство
Тип этого столбца в PHP. Возможные типы: строка, булево, целое число, двойное.
public string $phpType = null
$type общественное свойство
Абстрактный тип этого столбца. Возможные абстрактные типы: строка, текст, булево, smallint, целое число, bigint, float, decimal, datetime, timestamp, время, дата, двоичный и денежный.
public string $type = null
Подробное описание методов
dbTypecast() public метод
Преобразует входное значение в соответствии с $type и $dbType для использования в запросе к базе данных.
Если значение равно null или является yii\db\Expression, оно не будет преобразовано.
| public mixed dbTypecast ( $value ) | ||
|---|---|---|
| $value | mixed |
Входное значение |
| return | mixed |
Преобразованное значение. Также может быть массивом, содержащим значение в качестве первого элемента и тип PDO во втором. |
phpTypecast() public метод
Преобразует входное значение в соответствии с $phpType после извлечения из базы данных.
Если значение равно null или является yii\db\Expression, оно не будет преобразовано.
| public mixed phpTypecast ( $value ) | ||
|---|---|---|
| $value | mixed |
Входное значение |
| return | mixed |
Преобразованное значение |
typecast() защищённый метод (доступен с версии 2.0.3)
Преобразует входное значение в соответствии с $phpType после извлечения из базы данных.
Если значение равно null или является yii\db\Expression, оно не будет преобразовано.
| protected mixed typecast ( $value ) | ||
|---|---|---|
| $value | mixed |
Входное значение |
| return | mixed |
Преобразованное значение |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-sphinx-columnschema.html
