Spec-Zone.ru › CakePHP 3.3

Класс Collection

Представляет коллекцию схемы базы данных

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

Прямые подклассы

  • Cake\Database\Schema\CachedCollection
Пространство имён: Cake\Database\Schema
Расположение: Database/Schema/Collection.php

Краткое описание свойств

  • $_connection protected
    Cake\Datasource\ConnectionInterface
    Объект подключения
  • $_dialect protected
    Cake\Database\Schema\BaseSchema
    Экземпляр диалекта схемы.

Краткое описание методов

  • __construct() public
    Конструктор.
  • _reflect() protected
    Вспомогательный метод для выполнения каждого этапа процесса рефлексии.
  • describe() public
    Получить метаданные столбца для таблицы.
  • listTables() public
    Получить список таблиц, доступных в текущем подключении.

Подробное описание методов

__construct()source public

__construct( Cake\Datasource\ConnectionInterface $connection )

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

Параметры

Cake\Datasource\ConnectionInterface $connection
Экземпляр подключения.

_reflect()source protected

_reflect( string $stage , string $name , array $config , Cake\Database\Schema\Table $table )

Вспомогательный метод для выполнения каждого этапа процесса рефлексии.

Параметры

строка $stage
Имя этапа.
строка $name
Имя таблицы.
массив $config
Данные конфигурации.
Cake\Database\Schema\Table $table
Экземпляр таблицы

Исключения

Cake\Database\Exception
при ошибке запроса.

describe()source public

describe( string $name , array $options [] )

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

Кэширование будет применено, если cacheMetadata ключ присутствует в параметрах конфигурации подключения. По умолчанию, cake_model, если истинно.

Параметры

  • forceRefresh - Установите значение true, чтобы принудительно перестроить кэшированные метаданные. По умолчанию false.

Параметры

строка $name
Имя таблицы для описания.
массив $options необязательно []
Параметры, см. выше.

Возвращает

Cake\Database\Schema\Table
Объект с метаданными столбца.

Исключения

Cake\Database\Exception
если таблица не может быть описана.

listTables()source public

listTables( )

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

Возвращает

массив
Список таблиц в подключенной базе данных/схеме.

Подробное описание свойств

$_connectionsource

protected Cake\Datasource\ConnectionInterface

Объект подключения

$_dialectsource

protected Cake\Database\Schema\BaseSchema

Экземпляр диалекта схемы.

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.3/class-Cake.Database.Schema.Collection.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API