Класс TransportRegistry

_create()source protected

_create( string|Cake\Mailer\AbstractTransport $class , string $alias , array $config )

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

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

строка|Cake\Mailer\AbstractTransport $class

Имя класса или объект для создания.

строка $alias

Псевдоним объекта.

массив $config

Массив настроек для использования движка кэширования.

Возвращает

Cake\Mailer\AbstractTransport
Созданный класс транспортного средства.

Исключения

RuntimeException
при отсутствии реализации нужного интерфейса объектом.

_resolveClassName()source protected

_resolveClassName( string|Cake\Mailer\AbstractTransport $class )

Разрешение имени класса транспортного средства почтового клиента.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

строка|Cake\Mailer\AbstractTransport $class

Частичное имя класса для разрешения или экземпляр транспортного средства.

Возвращает

строка|false
Верное имя класса или false.

_throwMissingClassError()source protected

_throwMissingClassError( string $class , string $plugin )

Выбрасывает исключение, если отсутствует движок кэширования.

Часть шаблонового метода для Cake\Core\ObjectRegistry::load()

Параметры

строка $class

Отсутствующее имя класса.

строка $plugin

Плагин, в котором отсутствует движок кэширования.

Исключения

BadMethodCallException

unload()source public

unload( string $name )

Удаление одного адаптера из реестра.

Параметры

строка $name

Имя адаптера.

Переопределяет

Cake\Core\ObjectRegistry::unload()

__debugInfo()source public

__debugInfo( )

Свойства объекта, удобные для отладки.

Возвращает

массив

__get()source public

__get( string $name )

Предоставление публичного чтения загруженных объектов

Параметры

строка $name

Имя свойства для чтения

Возвращает

смешанное

__isset()source public

__isset( string $name )

Предоставление доступа isset к _loaded

Параметры

строка $name

Имя объекта, проверяемого на существование.

Возвращает

логическое

__set()source public

__set( string $name , mixed $object )

Установка объекта.

Параметры

строка $name

Имя свойства для установки.

смешанное $object

Объект для установки.

__unset()source public

__unset( string $name )

Удаление объекта.

Параметры

строка $name

Имя свойства для удаления.

_checkDuplicate()source protected

_checkDuplicate( string $name , array $config )

Проверка на дублирование загрузки объекта.

Если загружается дубликат с разными конфигурациями, это ошибка, и будет выброшено исключение.

Исключение вызывается, так как замена объекта не обновит ссылки, которые другие объекты могут иметь. Кроме того, простое обновление конфигурации во время выполнения не является хорошим вариантом, так как могут быть пропущены важные логики конструктора, зависящие от конфигурации.

Параметры

строка $name

Имя псевдонима в реестре.

массив $config

Данные конфигурации для нового экземпляра.

Исключения

RuntimeException
При обнаружении дубликата.

count()source public

count( )

Возвращает количество загруженных объектов.

Возвращает

целое число

Реализация

Countable::count()

get()source public

get( string $name )

Получение экземпляра загруженного объекта.

Параметры

строка $name

Имя объекта.

Возвращает

объект|null
Экземпляр объекта, если он загружен, иначе null.

getIterator()source public

getIterator( )

Возвращает итератор массива.

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source public

has( string $name )

Проверка загрузки объекта.

Параметры

строка $name

Имя объекта для проверки.

Возвращает

логическое
True, если объект загружен, иначе false.

load()source public

load( string $objectName , array $config = [] )

Загрузка/создание экземпляра объекта.

Возвращает экземпляр из реестра, если он уже существует. Если подкласс поддерживает события, вы можете использовать $config['enabled'] = false для исключения созданных объектов из регистрации событий.

Например, используя Cake\Controller\Controller::$components. Вы можете задать псевдоним объекта, установив ключ 'className', например:

public $components = [
  'Email' => [
    'className' => '\App\Controller\Component\AliasedEmailComponent'
  ];
];

Все вызовы к компоненту Email будут использовать AliasedEmail вместо.

Параметры

строка $objectName

Имя/класс объекта для загрузки.

массив $config необязательно []

Дополнительные настройки для загрузки объекта.

Возвращает

смешанное

Исключения

Исключение
Если класс не найден.

loaded()source public

loaded( )

Получение списка загруженных объектов.

Возвращает

строковый массив
Список имён объектов.

normalizeArray()source public

normalizeArray( array $objects )

Нормализует массив объектов, создаёт массив, который упрощает ленивую загрузку

Параметры

массив $objects

Массив дочерних объектов для нормализации.

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

массив
Массив нормализованных объектов.

reset()source public

reset( )

Очистить загруженные экземпляры в реестре.

Если подкласс реестра имеет менеджер событий, объекты также будут отделены от событий.

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

$this

set()source public

set( string $objectName , object $object )

Установить объект непосредственно в реестр по имени.

Если эта коллекция реализует события, переданный объект будет присоединён к менеджеру событий

Параметры

строка $objectName

Имя объекта для установки в реестр.

объект $object

экземпляр для хранения в реестре

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

$this