Класс yii\db\ColumnSchema
| Наследование | yii\db\ColumnSchema » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/db/ColumnSchema.php |
Класс ColumnSchema описывает метаданные столбца в таблице базы данных.
Общедоступные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $allowNull | boolean | Может ли столбец принимать значение NULL. | yii\db\ColumnSchema |
| $autoIncrement | boolean | Является ли столбец автоинкрементным | yii\db\ColumnSchema |
| $comment | string | Комментарий к столбцу. Не все СУБД поддерживают это. | yii\db\ColumnSchema |
| $dbType | string | Тип данных столбца в СУБД. Возможные типы зависят от СУБД. | yii\db\ColumnSchema |
| $defaultValue | mixed | Значение по умолчанию для этого столбца | yii\db\ColumnSchema |
| $enumValues | array | Перечислимые значения. Устанавливается только если столбец является перечислимым типом. | yii\db\ColumnSchema |
| $isPrimaryKey | boolean | Является ли столбец первичным ключом | yii\db\ColumnSchema |
| $name | string | Имя столбца (без кавычек). | yii\db\ColumnSchema |
| $phpType | string | Тип данных столбца в PHP. Возможные типы: string, boolean, integer, double. | yii\db\ColumnSchema |
| $precision | integer | Точность данных столбца, если он является числовым. | yii\db\ColumnSchema |
| $scale | integer | Масштаб данных столбца, если он является числовым. | yii\db\ColumnSchema |
| $size | integer | Размер отображения столбца. | yii\db\ColumnSchema |
| $type | string | Абстрактный тип данных этого столбца. Возможные типы: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binary, money. | yii\db\ColumnSchema |
| $unsigned | boolean | Является ли столбец беззнаковым. Имеет значение только если $type равен smallint, integer или bigint. | yii\db\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\db\ColumnSchema |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует объект. | yii\base\Object |
| phpTypecast() | Преобразует входное значение в соответствии с $phpType после извлечения из базы данных. | yii\db\ColumnSchema |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| typecast() | Преобразует входное значение в соответствии с $phpType после извлечения из базы данных. | yii\db\ColumnSchema |
Подробное описание свойств
$allowNull свойство public
Может ли столбец принимать значение NULL.
public boolean $allowNull = null
$autoIncrement свойство public
Является ли столбец автоинкрементным
public boolean $autoIncrement = false
$comment свойство public
Комментарий к столбцу. Не все СУБД поддерживают это.
public string $comment = null
$dbType свойство public
Тип данных столбца в СУБД. Возможные типы зависят от СУБД.
public string $dbType = null
$defaultValue свойство public
Значение по умолчанию для этого столбца
public mixed $defaultValue = null
$enumValues свойство public
Перечислимые значения. Устанавливается только если столбец является перечислимым типом.
public array $enumValues = null
$isPrimaryKey свойство public
Является ли столбец первичным ключом
public boolean $isPrimaryKey = null
$name свойство public
Имя столбца (без кавычек).
public string $name = null
$phpType свойство public
Тип данных столбца в PHP. Возможные типы: string, boolean, integer, double.
public string $phpType = null
$precision свойство public
Точность данных столбца, если он является числовым.
public integer $precision = null
$scale свойство public
Масштаб данных столбца, если он является числовым.
public integer $scale = null
$size свойство public
Размер отображения столбца.
public integer $size = null
$type свойство public
Абстрактный тип данных этого столбца. Возможные типы: char, string, text, boolean, smallint, integer, bigint, float, decimal, datetime, timestamp, time, date, binary, money.
public string $type = null
$unsigned свойство public
Является ли столбец беззнаковым. Это имеет значение только, когда $type равен smallint, integer или bigint.
public boolean $unsigned = null
Подробное описание методов
dbTypecast() public method
Преобразует входное значение в соответствии с $type и $dbType для использования в запросе к базе данных.
Если значение равно null или является yii\db\Expression, оно не будет преобразовано.
| public mixed dbTypecast ( $value ) | ||
|---|---|---|
| $value | mixed |
Входное значение |
| return | mixed |
Преобразованное значение. Может также быть массивом, содержащим значение в качестве первого элемента и тип PDO во втором. |
phpTypecast() public method
Преобразует входное значение в соответствии с $phpType после извлечения из базы данных.
Если значение равно null или является yii\db\Expression, оно не будет преобразовано.
| public mixed phpTypecast ( $value ) | ||
|---|---|---|
| $value | mixed |
Входное значение |
| return | mixed |
Преобразованное значение |
typecast() protected method (available since version 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-db-columnschema.html
