Spec-Zone.ru › CakePHP 3.4

Класс 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
    Получение экземпляра таблицы из реестра.
  • getTableLocator() public static
    Возвращает одиночный экземпляр реализации LocatorInterface.
  • locator() public static
    Устанавливает и возвращает одиночный экземпляр реализации LocatorInterface.
  • remove() public static
    Удаляет экземпляр из реестра.
  • set() public static
    Устанавливает экземпляр.
  • setTableLocator() public static
    Устанавливает одиночный экземпляр реализации LocatorInterface.

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

__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 optional null
Имя псевдонима
array|null $options optional 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 optional []
Параметры для построения таблицы.

Возвращает

Cake\ORM\Table

getTableLocator()source public static

getTableLocator( )

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

Возвращает

Cake\ORM\Locator\LocatorInterface

locator()source public static

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

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

Устаревшее

3.5.0 Используйте getTableLocator()/setTableLocator() вместо этого.

Параметры

Cake\ORM\Locator\LocatorInterface $locator optional 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

setTableLocator()source public static

setTableLocator( Cake\ORM\Locator\LocatorInterface $tableLocator )

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

Параметры

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

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

$_defaultLocatorClasssource

protected static string

Класс по умолчанию для реализации 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.4/class-Cake.ORM.TableRegistry.html

Spec-Zone.ru

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