Класс Таблица

__construct()source public

__construct( string $table , array $columns [] )

Конструктор.

Параметры

string $table

Имя таблицы.

array $columns optional []

Список столбцов для схемы.

_checkForeignKey()source protected

_checkForeignKey( array $attrs )

Вспомогательный метод для проверки/валидации внешних ключей.

Параметры

array $attrs

Атрибуты для установки.

Возвращает

array

Выбрасывает

Cake\Database\Exception
При неверном определении внешнего ключа.

addColumn()source public

addColumn( string $name , array $attrs )

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

Атрибуты

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

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

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

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

Параметры

string $name

Имя столбца

array $attrs

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

Возвращает

$this

addConstraint()source public

addConstraint( string $name , array $attrs )

Добавить ограничение.

Используется для добавления ограничений к таблице, например, первичных ключей, уникальных ключей и внешних ключей.

Атрибуты

• type Тип добавляемого ограничения.
• columns Столбцы в индексе.
• references Таблица, столбец, который ссылается внешний ключ.
• update Поведение при обновлении. Доступные варианты: 'restrict', 'setNull', 'cascade', 'noAction'.
• delete Поведение при удалении. Доступные варианты: 'restrict', 'setNull', 'cascade', 'noAction'.

Значение по умолчанию для 'update' и 'delete' — 'cascade'.

Параметры

string $name

Имя ограничения.

array $attrs

Атрибуты для ограничения.

Возвращает

$this

Выбрасывает

Cake\Database\Exception

addConstraintSql()source public

addConstraintSql( Cake\Datasource\ConnectionInterface $connection )

Сгенерировать SQL-запросы для добавления ограничений к таблице

Параметры

Cake\Datasource\ConnectionInterface $connection

Соединение для генерации SQL.

Возвращает

array
SQL для удаления таблицы.

addIndex()source public

addIndex( string $name , array $attrs )

Добавить индекс.

Используется для добавления индексов и полнотекстовых индексов в платформах, которые их поддерживают.

Атрибуты

• type Тип добавляемого индекса.
• columns Столбцы в индексе.

Параметры

string $name

Имя индекса.

array $attrs

Атрибуты для индекса.

Возвращает

$this

Выбрасывает

Cake\Database\Exception

baseColumnType()source public

baseColumnType( string $column )

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

Параметры

string $column

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

Возвращает

string
Базовое имя типа

column()source public

column( string $name )

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

Параметры

string $name

Имя столбца.

Возвращает

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

columnType()source public

columnType( string $name , string|null $type null )

Устанавливает тип столбца или возвращает его текущий тип, если он не передан.

Параметры

string $name

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

string|null $type optional null

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

Возвращает

string|null
Тип столбца или null.

columns()source public

columns( )

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

Возвращает

array

constraint()source public

constraint( string $name )

Получить информацию о ограничении по имени.

Параметры

string $name

Имя ограничения.

Возвращает

array|null
Данные ограничения, или null

constraints()source public

constraints( )

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

Возвращает

array

createSql()source public

createSql( Cake\Datasource\ConnectionInterface $connection )

Генерировать SQL для создания таблицы.

Использует соединение для доступа к диалекту схемы для генерации платформоспецифического SQL.

Параметры

Cake\Datasource\ConnectionInterface $connection

Соединение для генерации SQL.

Возвращает

array

Список SQL-запросов для создания таблицы и необходимых индексов.

defaultValues()source public

defaultValues( )

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

Возвращает

array

dropConstraint()source public

dropConstraint( string $name )

Удалить ограничение.

Параметры

string $name

Имя ограничения для удаления

dropConstraintSql()source public

dropConstraintSql( Cake\Datasource\ConnectionInterface $connection )

Сгенерировать SQL-запросы для удаления ограничений из таблицы

Параметры

Cake\Datasource\ConnectionInterface $connection

Соединение для генерации SQL.

Возвращает

array
SQL для удаления таблицы.

dropSql()source public

dropSql( Cake\Datasource\ConnectionInterface $connection )

Генерировать SQL для удаления таблицы.

Использует соединение для доступа к диалекту схемы для генерации платформоспецифического SQL.

Параметры

Cake\Datasource\ConnectionInterface $connection

Соединение для генерации SQL.

Возвращает

array
SQL для удаления таблицы.

hasAutoincrement()source public

hasAutoincrement( )

Проверить, есть ли в таблице столбец с автоинкрементом.

Возвращает

boolean

index()source public

index( string $name )

Получить информацию об индексе по имени.

Параметры

string $name

Имя индекса.

Возвращает

array|null
Данные индекса или null

indexes()source public

indexes( )

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

Возвращает

array

isNullable()source public

isNullable( string $name )

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

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

Параметры

string $name

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

Возвращает

boolean
Возможно ли значение null для поля.

name()source public

name( )

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

Возвращает

string

options()source public

options( array|null $options null )

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

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

Параметры

array|null $options optional null

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

Возвращает

$this|array Экземпляр таблицы или массив параметров при чтении.

primaryKey()source public

primaryKey( )

Получить имя(а) столбца(ов), используемого(ых) в качестве первичного ключа.

Возвращает

array

Имя(а) столбца(ов) первичного ключа. При отсутствии первичного ключа возвращается пустой массив.

temporary()source public

temporary( boolean|null $set null )

Получить/установить, является ли таблица временной в базе данных.

Параметры

boolean|null $set optional null

Является ли таблица временной.

Возвращает

$this|bool Экземпляр таблицы или текущее значение временного статуса.

truncateSql()source public

truncateSql( Cake\Datasource\ConnectionInterface $connection )

Генерировать SQL-запросы для обнуления таблицы

Параметры

Cake\Datasource\ConnectionInterface $connection

Соединение для генерации SQL.

Возвращает

array
SQL для обнуления таблицы.

typeMap()source public

typeMap( )

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

Возвращает

array

[
    'string' => [
        'fixed' => null,
        'collate' => null,
    ],
    'text' => [
        'collate' => null,
    ],
    'integer' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'biginteger' => [
        'unsigned' => null,
        'autoIncrement' => null,
    ],
    'decimal' => [
        'unsigned' => null,
    ],
    'float' => [
        'unsigned' => null,
    ],
]

[
    'type' => null,
    'baseType' => null,
    'length' => null,
    'precision' => null,
    'null' => null,
    'default' => null,
    'comment' => null,
]

[]

[]

[
    'type' => null,
    'columns' => [],
    'length' => [],
    'references' => [],
    'update' => 'restrict',
    'delete' => 'restrict',
]

[]

[]

false

[]

[
    self::CONSTRAINT_PRIMARY,
    self::CONSTRAINT_UNIQUE,
    self::CONSTRAINT_FOREIGN,
]

[
    self::ACTION_CASCADE,
    self::ACTION_SET_NULL,
    self::ACTION_SET_DEFAULT,
    self::ACTION_NO_ACTION,
    self::ACTION_RESTRICT,
]

[
    self::INDEX_INDEX,
    self::INDEX_FULLTEXT,
]

[
    'tiny' => self::LENGTH_TINY,
    'medium' => self::LENGTH_MEDIUM,
    'long' => self::LENGTH_LONG
]