Spec-Zone.ru › CakePHP 3.3

Класс 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 )

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

Параметры

строка $name
Имя метода.
массив $arguments
Аргументы метода.

Возвращает

смешанный

clear()source public static

clear( )

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

config()source public static

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

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

Параметры

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

Возвращает

массив
Данные конфигурации.

exists()source public static

exists( string $alias )

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

Параметры

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

Возвращает

булево

get()source public static

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

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

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

Параметры

строка $alias
Имя псевдонима, который нужно получить.
массив $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 )

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

Параметры

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

set()source public static

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

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

Параметры

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

Возвращает

Cake\ORM\Table

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

$_defaultLocatorClasssource

protected static строка

Реализация класса по умолчанию LocatorInterface.

'Cake\ORM\Locator\TableLocator'

$_locatorsource

protected static Cake\ORM\Locator\LocatorInterface

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

© 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.3/class-Cake.ORM.TableRegistry.html

Spec-Zone.ru

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