Spec-Zone.ru › CakePHP 3.7

Класс TableLocator

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

Cake\ORM\Locator\TableLocator реализует Cake\ORM\Locator\LocatorInterface
Пространство имён: Cake\ORM\Locator
Расположение: ORM/Locator/TableLocator.php

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

  • $_config protected
    array
    Конфигурация для псевдонимов.
  • $_fallbacked protected
    Cake\ORM\Table[]

    Содержит список объектов Table, созданных на основе встроенного класса Table. Список индексируется по псевдониму таблицы

  • $_instances protected
    Cake\ORM\Table[]
    Экземпляры, принадлежащие регистру.
  • $_options protected
    array
    Содержит список опций, переданных в метод get().

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

  • _create() protected
    Обёртка для создания экземпляров таблиц
  • _getClassName() protected
    Получение имени класса таблицы.
  • clear() public
    Очистка реестра от конфигурации и экземпляров.
  • config() public deprecated

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

  • exists() public
    Проверка наличия экземпляра в реестре.
  • genericInstances() public

    Возвращает список таблиц, созданных этим регистром, которые не могли быть созданы из конкретного подкласса. Этот метод полезен для отладки распространённых ошибок при настройке ассоциаций или создании новых классов таблиц.

  • get() public
    Получение экземпляра таблицы из реестра.
  • getConfig() public
    Возвращает конфигурацию для псевдонима или весь массив конфигурации для всех псевдонимов.
  • remove() public
    Удаление экземпляра из реестра.
  • set() public
    Установка экземпляра.
  • setConfig() public

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

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

_create()source protected

_create( array $options )

Обёртка для создания экземпляров таблиц

Параметры

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

Возвращает

Cake\ORM\Table

_getClassName()source protected

_getClassName( string $alias , array $options = [] )

Получение имени класса таблицы.

Параметры

строка $alias
Имя псевдонима, которое вы хотите получить.
массив $options опционально []
Массив опций таблицы.

Возвращает

строка|ложь

clear()source public

clear( )

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

Реализация

Cake\ORM\Locator\LocatorInterface::clear()

config()source public deprecated

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

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

Опции, которые могут быть сохранены, — те, которые распознаются get() Если второй аргумент опущен, он вернёт текущие настройки для $alias.

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

Устарело

3.4.0 Используйте setConfig()/getConfig() вместо этого.

Параметры

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

Возвращает

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

Исключения

RuntimeException
При попытке настроить существующий экземпляр таблицы.

Реализация

Cake\ORM\Locator\LocatorInterface::config()

exists()source public

exists( string $alias )

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

Параметры

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

Возвращает

логическое значение

Реализация

Cake\ORM\Locator\LocatorInterface::exists()

genericInstances()source public

genericInstances( )

Возвращает список таблиц, созданных этим регистром, которые не могли быть созданы из конкретного подкласса. Этот метод полезен для отладки распространённых ошибок при настройке ассоциаций или создании новых классов таблиц.

Возвращает

Cake\ORM\Table[]

get()source public

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

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

Таблицы создаются только один раз до сброса реестра. Это означает, что псевдонимы должны быть уникальными во всём приложении. Это важно, поскольку ассоциации таблиц разрешаются во время выполнения, и циклические ссылки должны обрабатываться правильно.

Опции, которые могут быть переданы, такие же, как в Cake\ORM\Table::__construct(), но также распознаётся ключ className.

Опции

  • className Определяет конкретное имя класса для использования. Если не определено, CakePHP сгенерирует имя класса на основе псевдонима. Например, 'Users' приведёт к использованию App\Model\Table\UsersTable. Если этот класс не существует, будет использован стандартный класс Cake\ORM\Table. Установив опцию className, вы можете определить конкретный класс для использования. Опция className поддерживает сокращённые ссылки на классы плагинов Cake\Core\App::shortName().
  • table Определяет имя таблицы для использования. Если не определено, эта опция по умолчанию будет содержать нижнее подчеркивание версии имени псевдонима.
  • connection Вводит конкретный объект подключения для использования. Если эта опция и connectionName не определены, метод defaultConnectionName() класса таблицы будет вызван для получения имени подключения.
  • connectionName Определяет имя подключения для использования. Названное подключение извлекается из Cake\Datasource\ConnectionManager.

Примечание Если ваш $alias использует синтаксис плагина, только имя будет использоваться в качестве ключа в реестре. Это означает, что если два плагина или плагин и приложение предоставляют один и тот же псевдоним, в реестре будет храниться только первый экземпляр.

Параметры

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

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

Возвращает

Cake\ORM\Table

Исключения

RuntimeException
При попытке настроить псевдоним, который уже существует.

Реализация

Cake\ORM\Locator\LocatorInterface::get()

getConfig()source public

getConfig( string|null $alias = null )

Возвращает конфигурацию для псевдонима или весь массив конфигурации для всех псевдонимов.

Параметры

строка|null $alias опционально null
Псевдоним для получения конфигурации, null для полной конфигурации.

Возвращает

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

remove()source public

remove( string $alias )

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

Параметры

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

Реализация

Cake\ORM\Locator\LocatorInterface::remove()

set()source public

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

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

Параметры

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

Возвращает

Cake\ORM\Table

Реализация

Cake\ORM\Locator\LocatorInterface::set()

setConfig()source public

setConfig( string|array $alias , array|null $options = null )

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

Параметры

string|array $alias
Имя псевдонима или массив для полного перезаписи текущей конфигурации.
array|null $options необязательно null
список параметров для псевдонима

Возвращает


$this

Исключение

RuntimeException
При попытке настроить существующий экземпляр таблицы.

Магические методы, унаследованные от Cake\ORM\Locator\LocatorInterface

getConfig()

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

$_configsource

protected array

Конфигурация для псевдонимов.

[]

$_fallbackedsource

protected Cake\ORM\Table[]

Содержит список объектов Table, созданных из встроенного класса Table. Список индексируется по псевдониму таблицы

[]

$_instancessource

protected Cake\ORM\Table[]

Экземпляры, принадлежащие реестру.

[]

$_optionssource

protected array

Содержит список параметров, переданных методу get().

[]

© 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.ORM.Locator.TableLocator.html

Spec-Zone.ru

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