Spec-Zone.ru › CakePHP 3.3

Класс TableLocator

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

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

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

  • $_config protected
    array
    Конфигурация псевдонимов.
  • $_fallbacked protected
    array

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

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

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

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

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

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

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

  • get() public
    Получение экземпляра таблицы из регистра.
  • remove() public
    Удаление экземпляра из регистра.
  • set() 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|null $alias null , array|null $options null )

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

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

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

Параметры

строка|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( )

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

Возвращает

массив

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()

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()

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

$_configsource

protected массив

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

[]
END_OF_DOCUMENT_MARKER

$_fallbackedsource

protected array

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

[]

$_instancessource

protected array

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

[]

$_optionssource

protected array

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

Spec-Zone.ru

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