Spec-Zone.ru › CakePHP 3.3

Класс CachedCollection

Расширяет класс схемы коллекции, чтобы предоставить кеширование

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

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

  • $_cache protected
    string|boolean

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

Унаследованные свойства

  • _connection, _dialect

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

  • __construct() public
    Конструктор.
  • cacheKey() public
    Получить ключ кеша для заданного имени.
  • cacheMetadata() public

    Устанавливает имя конфигурации кеша для кеширования метаданных таблиц или отключает кеширование, если передано значение false. Если вызывается без аргументов, возвращает текущее имя конфигурации.

  • describe() public
    Получить метаданные столбцов для таблицы.

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

__construct()source public

__construct( Cake\Datasource\ConnectionInterface $connection , string|boolean $cacheKey true )

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

Параметры

Cake\Datasource\ConnectionInterface $connection
Экземпляр соединения.
строка|логическое $cacheKey необязательно true
Ключ кеша или логическое значение false для отключения кеширования.

Переопределяет

Cake\Database\Schema\Collection::__construct()

cacheKey()source public

cacheKey( string $name )

Получить ключ кеша для заданного имени.

Параметры

строка $name
Имя для получения ключа кеша.

Возвращает

строка
Ключ кеша.

cacheMetadata()source public

cacheMetadata( boolean|null $enable null )

Устанавливает имя конфигурации кеша для кеширования метаданных таблиц или отключает кеширование, если передано значение false. Если вызывается без аргументов, возвращает текущее имя конфигурации.

Параметры

логическое|null $enable необязательно null
включить или отключить кеширование

Возвращает

строка|логическое

describe()source public

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

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

Параметры

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

Возвращает

объект с метаданными столбцов.

Выбрасывает

исключение
при невозможности описания таблицы.

Переопределяет

Cake\Database\Schema\Collection::describe()

Методы, унаследованные от Cake\Database\Schema\Collection

_reflect()source protected

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

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

Параметры

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

Выбрасывает

исключение
при сбое запроса.

listTables()source public

listTables( )

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

Возвращает

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

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

$_cachesource

protected строка|логическое

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

false

© 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.CachedCollection.html

Spec-Zone.ru

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