Spec-Zone.ru › CakePHP 3.6

Класс CachedCollection

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

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

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

  • $_cache protected
    string|boolean

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

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

  • _connection, _dialect

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

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

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

  • describe() public
    Получить метаданные столбцов для таблицы.
  • getCacheMetadata() public
    Получить имя конфигурации кеша для кеширования метаданных таблицы, false означает отключение.
  • setCacheMetadata() public

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

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

__construct()source public

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

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

Параметры

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

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

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

cacheKey()source public

cacheKey( string $name )

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

Параметры

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

Возвращает

string
Ключ кеша.

cacheMetadata()source public deprecated

cacheMetadata( boolean|null $enable = null )

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

Устаревшее

3.4.0 Используйте setCacheMetadata()/getCacheMetadata()

Параметры

boolean|null $enable optional null
Включить или отключить кеширование

Возвращает

string|boolean

describe()source public

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

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

Параметры

string $name
Имя таблицы для описания.
array $options optional []
Опции, см. выше.

Возвращает

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

Выбрасывает

Cake\Database\Exception
при невозможности описания таблицы.

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

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

getCacheMetadata()source public

getCacheMetadata( )

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

Возвращает

string|boolean

setCacheMetadata()source public

setCacheMetadata( boolean $enable )

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

Параметры

boolean $enable
Включить или отключить кеширование

Возвращает


$this

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

_reflect()source protected

_reflect( string $stage , string $name , array $config , Cake\Database\Schema\TableSchema $schema )

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

Параметры

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

Выбрасывает

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

listTables()source public

listTables( )

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

Возвращает

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

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

$_cachesource

protected string|boolean

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

false

© 2005–present 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.6/class-Cake.Database.Schema.CachedCollection.html

Spec-Zone.ru

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