Интерфейс SchemaInterface

addColumn()source public

addColumn( string $name , array|string $attrs )

Добавить столбец в таблицу.

Атрибуты

Столбцы могут иметь несколько атрибутов:

• type Тип столбца. Должен быть одним из абстрактных типов CakePHP.
• length Длина столбца.
• precision Количество десятичных знаков для хранения для типов float и decimal.
• default Значение по умолчанию для столбца.
• null Возможность хранения null.
• fixed Является ли столбец столбцом фиксированной длины. Присутствует/допустим только для столбцов типа string.
• unsigned Является ли столбец беззнаковым. Присутствует/допустим для столбцов integer, decimal, float.

Помимо вышеперечисленных ключей, следующие ключи реализованы в некоторых диалектах баз данных, но не во всех:

• comment Комментарий к столбцу.

Параметры

строка $name

Имя столбца

массив|строка $attrs

Атрибуты столбца.

Возвращаемое значение

$this

baseColumnType()source public

baseColumnType( string $column )

Возвращает имя базового типа для указанного столбца. Представляет базовый тип данных в базе данных, на котором основан более сложный класс.

Параметры

строка $column

Имя столбца для получения базового типа

Возвращаемое значение

строка|null
Имя базового типа

columns()source public

columns( )

Получить имена столбцов в таблице.

Возвращаемое значение

строки[]

defaultValues()source public

defaultValues( )

Получить хеш столбцов и их значений по умолчанию.

Возвращаемое значение

массив

getColumn()source public

getColumn( string $name )

Получить данные столбца в таблице.

Параметры

строка $name

Имя столбца.

Возвращаемое значение

массив|null
Данные столбца или null.

getColumnType()source public

getColumnType( string $name )

Возвращает тип столбца или null, если столбец не существует.

Параметры

строка $name

Столбец, тип которого нужно получить.

Возвращаемое значение

строка|null

getOptions()source public

getOptions( )

Получить опции для таблицы.

Опции таблицы позволяют устанавливать платформенно-специфические опции уровня таблицы. Например, тип движка в MySQL.

Возвращаемое значение

массив
Массив опций.

hasColumn()source public

hasColumn( string $name )

Возвращает true, если столбец существует в схеме.

Параметры

строка $name

Имя столбца.

Возвращаемое значение

булево

isNullable()source public

isNullable( string $name )

Проверить, является ли поле допустимым null.

Отсутствующие столбцы допустимы null.

Параметры

строка $name

Столбец, тип которого нужно получить.

Возвращаемое значение

булево
Является ли поле допустимым null.

name()source public

name( )

Получить имя таблицы.

Возвращаемое значение

строка

removeColumn()source public

removeColumn( string $name )

Удалить столбец из схемы таблицы.

Если столбец не определен в таблице, ошибка не будет вызвана.

Параметры

строка $name

Имя столбца

Возвращаемое значение

$this

setColumnType()source public

setColumnType( string $name , string $type )

Устанавливает тип столбца.

Параметры

строка $name

Столбец, тип которого нужно установить.

строка $type

Тип, на который нужно установить столбец.

Возвращаемое значение

$this

setOptions()source public

setOptions( array $options )

Устанавливает опции для таблицы.

Опции таблицы позволяют устанавливать платформенно-специфические опции уровня таблицы. Например, тип движка в MySQL.

Параметры

массив $options

Опции для установки или null для чтения опций.

Возвращаемое значение

$this

typeMap()source public

typeMap( )

Возвращает массив, где ключи — имена столбцов в схеме, а значения — типы данных базы данных.

Возвращаемое значение

массив