Класс CachedCollection
Расширяет класс схемы коллекции, чтобы обеспечить кэширование
- 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 - Экземпляр подключения.
- строка|логическое
$cacheKeyнеобязательно true - Ключ кэша или логическое значение false для отключения кэширования.
Переопределяет
Cake\Database\Schema\Collection::__construct() cacheKey()source public
cacheKey( string $name )
Получение ключа кэша для данного имени.
Параметры
- строка
$name - Имя для получения ключа кэша.
Возвращает
строкаКлюч кэша.
cacheMetadata()source public deprecated
cacheMetadata( boolean|null $enable = null )
Устанавливает имя конфигурации кэша для кэширования метаданных таблиц или отключает его, если передано значение false. Если вызывается без аргументов, возвращает текущее имя конфигурации.
Устарело
3.4.0 Используйте setCacheMetadata()/getCacheMetadata()Параметры
- логическое|null
$enableнеобязательно null - Включить или отключить кэширование
Возвращает
строка|логическоеdescribe()source public
describe( string $name , array $options = [] )
Получение метаданных столбцов для таблицы.
Параметры
- строка
$name - Имя таблицы для описания.
- массив
$optionsнеобязательно [] - Параметры для использования, см. выше.
Возвращает
Cake\Database\Schema\TableSchemaОбъект с метаданными столбцов.
Исключения
Cake\Database\Exceptionпри невозможности описания таблицы.
Переопределяет
Cake\Database\Schema\Collection::describe() getCacheMetadata()source public
getCacheMetadata( )
Получение имени конфигурации кэша для кэширования метаданных таблиц, false означает отключение.
Возвращает
строка|логическоеsetCacheMetadata()source public
setCacheMetadata( boolean $enable )
Устанавливает имя конфигурации кэша для кэширования метаданных таблиц или отключает его, если передано значение false.
Параметры
- логическое
$enable - Включить или отключить кэширование
Возвращает
$this
Методы, унаследованные от Cake\Database\Schema\Collection
_reflect()source protected
_reflect( string $stage , string $name , array $config , Cake\Database\Schema\TableSchema $schema )
Вспомогательный метод для выполнения каждого этапа процесса рефлексии.
Параметры
- строка
$stage - Имя этапа.
- строка
$name - Имя таблицы.
- массив
$config - Данные конфигурации.
-
Cake\Database\Schema\TableSchema$schema - Экземпляр таблицы
Исключения
Cake\Database\Exceptionпри ошибке запроса.
listTables()source public
listTables( )
Получение списка доступных таблиц в текущем подключении.
Возвращает
массивСписок таблиц в подключенной базе данных/схеме.
Подробное описание свойств
$_cachesource
protected строка|логическое
Имя ключа конфигурации кэша, используемого для кэширования метаданных таблиц, или 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.8/class-Cake.Database.Schema.CachedCollection.html