Класс 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 - Экземпляр соединения.
- 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.7/class-Cake.Database.Schema.CachedCollection.html