Spec-Zone.ru › CakePHP 3.4

Класс CachedCollection

Расширяет класс схемы коллекции, чтобы обеспечить кэширование

Cake\Database\Schema\Collection
Extended by Cake\Database\Schema\CachedCollection
Пространство имён: Cake\Database\Schema
Расположение: Database/Schema/CachedCollection.php

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

  • $_cache protected
    string|boolean

    Имя ключа конфигурации кэша, используемого для кэширования метаданных таблиц, или false, если кэширование отключено.

Наследованные свойства

  • _connection, _dialect

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

  • __construct() public
    Конструктор.
  • cacheKey() public
    Получение ключа кэша для заданного имени.
  • cacheMetadata() 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 $cacheKey optional true
Ключ кэша или логическое значение false для отключения кэширования.

Переопределяет

Cake\Database\Schema\Collection::__construct()

cacheKey()source public

cacheKey( string $name )

Получение ключа кэша для заданного имени.

Параметры

string $name
Имя для получения ключа кэша.

Возвращает

string
Ключ кэша.

cacheMetadata()source public

cacheMetadata( boolean|null $enable null )

Устанавливает имя конфигурации кэша для кэширования метаданных таблиц или отключает его, если передано значение false. Если вызов осуществляется без аргументов, возвращается текущее имя конфигурации.

Устарело

3.4.0 Используйте setCacheMetadata()/getCacheMetadata()

Параметры

boolean|null $enable optional null
Включать или отключать кэширование

Возвращает

string|boolean

describe()source public

describe( string $name , array $options [] )

Получение метаданных столбцов для таблицы.

Параметры

string $name
Имя таблицы для описания.
array $options optional []
Параметры для использования, см. выше.

Возвращает

Cake\Database\Schema\TableSchema
Объект с метаданными столбцов.

Выбрасывает

Cake\Database\Exception
при невозможности описания таблицы.

Переопределяет

Cake\Database\Schema\Collection::describe()

getCacheMetadata()source public

getCacheMetadata( )

Получает имя конфигурации кэша для кэширования метаданных таблиц; false означает отключение.

Возвращает

string|boolean

setCacheMetadata()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–2017 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.4/class-Cake.Database.Schema.CachedCollection.html

Spec-Zone.ru

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