Класс CachedCollection
Расширяет класс схемы коллекции, чтобы предоставить кэширование
- Cake\Database\Schema\Collection
-
Cake\Database\Schema\CachedCollection
Краткое описание свойств
-
$_cacheprotectedstring|booleanНазвание ключа конфигурации кэша для кэширования метаданных таблицы, или false, если отключено.
Наследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- cacheKey() publicПолучить ключ кэша для данного имени.
- cacheMetadata() public
Устанавливает имя конфигурации кэша для кэширования метаданных таблицы или отключает его, если передано 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
$cacheKeyoptional true - Ключ кэша или boolean false для отключения кэширования.
Переопределяет
Cake\Database\Schema\Collection::__construct() cacheKey()source public
cacheKey( string $name )
Получить ключ кэша для данного имени.
Параметры
- string
$name - Имя для получения ключа кэша.
Возвращает
stringКлюч кэша.
cacheMetadata()source public
cacheMetadata( boolean|null $enable null )
Устанавливает имя конфигурации кэша для кэширования метаданных таблицы или отключает его, если передано false. Если вызывается без аргументов, возвращает текущее имя конфигурации.
Устарело
3.4.0 Используйте setCacheMetadata()/getCacheMetadata()Параметры
- boolean|null
$enableoptional null - Включить или отключить кэширование
Возвращает
string|booleandescribe()source public
describe( string $name , array $options [] )
Получить метаданные столбцов для таблицы.
Параметры
- string
$name - Имя таблицы для описания.
- array
$optionsoptional [] - Параметры для использования, см. выше.
Возвращает
Cake\Database\Schema\TableSchemaОбъект с метаданными столбцов.
Издаёт исключение
Cake\Database\Exceptionпри невозможности описать таблицу.
Переопределяет
Cake\Database\Schema\Collection::describe() getCacheMetadata()source public
getCacheMetadata( )
Получает имя конфигурации кэша для кэширования метаданных таблицы, false означает отключение.
Возвращает
string|booleansetCacheMetadata()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–2018 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.5/class-Cake.Database.Schema.CachedCollection.html