Класс CachedCollection
Декорирует коллекцию схем и добавляет кэширование
Краткое описание свойств
- $cacher protected
Psr\SimpleCache\CacheInterfaceЭкземпляр кэшера.
- $collection protected
Cake\Database\Schema\CollectionInterfaceДекорированная коллекция схем
- $prefix protected
stringПрефикс ключа кэша
Краткое описание методов
-
__construct() public
Конструктор.
-
cacheKey() public
Получить ключ кэша для заданного имени.
-
describe() public
Получить метаданные столбцов для таблицы.
-
getCacher() public
Получить кэшер.
-
listTables() public
Получить список таблиц, доступных в текущем соединении.
-
setCacher() public
Установить кэшер.
Подробное описание методов
__construct() public
__construct(Cake\Database\Schema\CollectionInterface $collection, string $prefix, Psr\SimpleCache\CacheInterface $cacher)
Конструктор.
Параметры
-
Cake\Database\Schema\CollectionInterface$collection Коллекция для обертывания.
-
string$prefix Префикс ключа кэша для использования. Обычно имя соединения.
-
Psr\SimpleCache\CacheInterface$cacher Экземпляр кэшера.
cacheKey() public
cacheKey(string $name): string
Получить ключ кэша для заданного имени.
Параметры
-
string$name Имя для получения ключа кэша.
Возвращает
stringdescribe() public
describe(string $name, array $options = []): Cake\Database\Schema\TableSchemaInterface
Получить метаданные столбцов для таблицы.
Кэширование будет применено, если cacheMetadata ключ присутствует в опциях конфигурации соединения. По умолчанию _cakemodel, если значение true.
Опции
-
forceRefresh- Установите в значение true, чтобы принудительно перестроить кэшированные метаданные. По умолчанию false.
Параметры
-
string$name -
array$options optional
Возвращает
Cake\Database\Schema\TableSchemaInterfacegetCacher() public
getCacher(): Psr\SimpleCache\CacheInterface
Получить кэшер.
Возвращает
Psr\SimpleCache\CacheInterfacelistTables() public
listTables(): string[]
Получить список таблиц, доступных в текущем соединении.
Возвращает
string[]setCacher() public
setCacher(Psr\SimpleCache\CacheInterface $cacher): $this
Установить кэшер.
Параметры
-
Psr\SimpleCache\CacheInterface$cacher Объект кэшера
Возвращает
$thisПодробное описание свойств
$cacher protected
Экземпляр кэшера.
Тип
Psr\SimpleCache\CacheInterface$collection protected
Декорированная коллекция схем
Тип
Cake\Database\Schema\CollectionInterface$prefix protected
Префикс ключа кэша
Тип
string
© 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/4.2/class-Cake.Database.Schema.CachedCollection.html
