Spec-Zone.ru › CakePHP 3.2

Класс TableRegistry

Предоставляет реестр/фабрику для объектов Table.

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

Настройка экземпляров

Возможно, вам потребуется настроить ваши объекты таблиц, используя TableRegistry, вы можете централизовать конфигурацию. Любая конфигурация, заданная до создания экземпляров, будет использована при создании экземпляров. Если вы измените конфигурацию после создания экземпляра, экземпляры не будут обновлены.

TableRegistry::config('Users', ['table' => 'my_users']);

Данные конфигурации хранятся по псевдониму. Если вы используете одну и ту же таблицу с несколькими псевдонимами, вам необходимо установить конфигурацию несколько раз.

Получение экземпляров

Вы можете извлечь экземпляры из реестра с помощью метода get(). Один экземпляр хранится на каждый псевдоним. После заполнения псевдонима будет всегда возвращаться один и тот же экземпляр. Это используется для того, чтобы ORM использовал меньше памяти и помогало решать проблемы с циклическими ссылками.

$table = TableRegistry::get('Users', $config);
Пространство имён: Cake\ORM
Расположение: ORM/TableRegistry.php

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

  • $_defaultLocatorClass protected static
    string
    Класс реализации LocatorInterface по умолчанию.
  • $_locator protected static
    Cake\ORM\Locator\LocatorInterface
    Экземпляр реализации LocatorInterface.

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

  • __callStatic() public static
    Прокси для статических вызовов локета.
  • clear() public static
    Очищает реестр от конфигурации и экземпляров.
  • config() public static

    Хранит список параметров, которые будут использоваться при создании объекта с соответствующим псевдонимом.

  • exists() public static
    Проверяет наличие экземпляра в реестре.
  • get() public static
    Получение экземпляра таблицы из реестра.
  • locator() public static
    Устанавливает и возвращает одиночный экземпляр реализации LocatorInterface.
  • remove() public static
    Удаляет экземпляр из реестра.
  • set() public static
    Установка экземпляра.

Подробное описание методов

__callStatic()source public static

__callStatic( string $name , array $arguments )

Прокси для статических вызовов локета.

Параметры

string $name
Имя метода.
array $arguments
Аргументы метода.

Возвращает

mixed

clear()source public static

clear( )

Очищает реестр от конфигурации и экземпляров.

config()source public static

config( string|null $alias null , array|null $options null )

Хранит список параметров, которые будут использоваться при создании объекта с соответствующим псевдонимом.

Параметры

string|null $alias опционально null
Имя псевдонима
array|null $options опционально null
Список параметров для псевдонима

Возвращает

array
Данные конфигурации.

exists()source public static

exists( string $alias )

Проверяет наличие экземпляра в реестре.

Параметры

string $alias
Псевдоним для проверки.

Возвращает

boolean

get()source public static

get( string $alias , array $options [] )

Получение экземпляра таблицы из реестра.

См. описание параметров в TableLocator::get().

Параметры

string $alias
Имя псевдонима, которое нужно получить.
array $options опционально []
Параметры, с которыми нужно создать таблицу.

Возвращает

Cake\ORM\Table

locator()source public static

locator( Cake\ORM\Locator\LocatorInterface $locator null )

Устанавливает и возвращает одиночный экземпляр реализации LocatorInterface.

Параметры

Cake\ORM\Locator\LocatorInterface $locator опционально null
Экземпляр локета для использования.

Возвращает

Cake\ORM\Locator\LocatorInterface

remove()source public static

remove( string $alias )

Удаляет экземпляр из реестра.

Параметры

string $alias
Псевдоним для удаления.

set()source public static

set( string $alias , Cake\ORM\Table $object )

Установка экземпляра.

Параметры

string $alias
Псевдоним для установки.
Cake\ORM\Table $object
Таблица для установки.

Возвращает

Cake\ORM\Table

Подробное описание свойств

$_defaultLocatorClasssource

protected static string

Класс реализации LocatorInterface по умолчанию.

'Cake\ORM\Locator\TableLocator'

$_locatorsource

protected static Cake\ORM\Locator\LocatorInterface

Экземпляр реализации LocatorInterface.

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.ORM.TableRegistry.html

Spec-Zone.ru

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