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