Spec-Zone.ru › CakePHP 3.4

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

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

  • 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

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 )

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

Параметры

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

Реализация

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

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
При попытке настроить существующий экземпляр таблицы.

Подробности свойств

$_configsource

protected массив

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

[]

$_fallbackedsource

protected Cake\ORM\Table[]

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

[]

$_instancessource

protected Cake\ORM\Table[]

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

[]

$_optionssource

protected массив

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

[]

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

Spec-Zone.ru

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