Spec-Zone.ru › CakePHP 4.4

Класс CachedCollection

Декоратор схемы коллекции и добавления кеширования

Пространство имён: Cake\Database\Schema

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

  • $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

Имя, для которого нужно получить ключ кеша.

Возвращает

string

describe() публичный

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\TableSchemaInterface

getCacher() публичный

getCacher(): Psr\SimpleCache\CacheInterface

Получение кеширования.

Возвращает

Psr\SimpleCache\CacheInterface

listTables() публичный

listTables(): array<string>

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

Возвращает

array<string>

listTablesWithoutViews() публичный

listTablesWithoutViews(): array

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

Возвращает

array

setCacher() публичный

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.4/class-Cake.Database.Schema.CachedCollection.html

Spec-Zone.ru

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