Интерфейс SchemaInterface

addColumn()source public

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

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

Атрибуты

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

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

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

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

Параметры

string $name

Имя столбца

array|string $attrs

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

Возвращает

$this

baseColumnType()source public

baseColumnType( string $column )

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

Параметры

string $column

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

Возвращает

string|null
Имя базового типа

columns()source public

columns( )

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

Возвращает

string[]

defaultValues()source public

defaultValues( )

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

Возвращает

array

getColumn()source public

getColumn( string $name )

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

Параметры

string $name

Имя столбца.

Возвращает

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

getColumnType()source public

getColumnType( string $name )

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

Параметры

string $name

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

Возвращает

string|null

getOptions()source public

getOptions( )

Получить параметры таблицы.

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

Возвращает

array
Массив параметров.

hasColumn()source public

hasColumn( string $name )

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

Параметры

string $name

Имя столбца.

Возвращает

boolean

isNullable()source public

isNullable( string $name )

Проверить, является ли поле nullable

Отсутствующие столбцы являются nullable.

Параметры

string $name

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

Возвращает

boolean
Является ли поле nullable.

name()source public

name( )

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

Возвращает

string

removeColumn()source public

removeColumn( string $name )

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

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

Параметры

string $name

Имя столбца

Возвращает

$this

setColumnType()source public

setColumnType( string $name , string $type )

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

Параметры

string $name

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

string $type

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

Возвращает

$this

setOptions()source public

setOptions( array $options )

Устанавливает параметры таблицы.

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

Параметры

array $options

Параметры для установки, или null для чтения параметров.

Возвращает

$this

typeMap()source public

typeMap( )

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

Возвращает

array