Класс CachedCollection
Расширяет класс схемы collection, предоставляя кеширование
- Cake\Database\Schema\Collection
-
Cake\Database\Schema\CachedCollection
Краткое описание свойств
-
$_cacheprotectedstring|booleanИмя ключа конфигурации кеша для кеширования метаданных таблицы, или false, если отключено.
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- cacheKey() 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 deprecated
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–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