Spec-Zone.ru › CakePHP 3.6

Класс 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 для полной конфигурации.

Возвращаемое значение

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

remove()source public

remove( string $alias )

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

Параметры

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

Реализация

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

set()source public

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

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

Параметры

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

Возвращает

Cake\ORM\Table

Реализация

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

setConfig()source public

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

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

Параметры

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

Возвращает


$this

Исключения

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

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

getConfig()

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

$_configsource

protected массив

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

[]

$_fallbackedsource

protected Cake\ORM\Table[]

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

[]

$_instancessource

protected Cake\ORM\Table[]

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

[]

$_optionssource

protected массив

Содержит список параметров, переданных методу 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.6/class-Cake.ORM.Locator.TableLocator.html

Spec-Zone.ru

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