Класс TransportRegistry

_create()source защищённый

_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 защищённый

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

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

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

Параметры

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

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

Возвращает

строка|ложь
Либо правильное имя класса, либо ложь.

_throwMissingClassError()source защищённый

_throwMissingClassError( string $class , string $plugin )

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

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

Параметры

строка $class

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

строка $plugin

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

Выбрасывает

BadMethodCallException

unload()source публичный

unload( string $name )

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

Параметры

строка $name

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

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

Cake\Core\ObjectRegistry::unload()

__debugInfo()source публичный

__debugInfo( )

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

Возвращает

массив

__get()source публичный

__get( string $name )

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

Параметры

строка $name

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

Возвращает

смешанный тип

__isset()source публичный

__isset( string $name )

Обеспечение доступа isset к _loaded

Параметры

строка $name

Имя объекта, который проверяется.

Возвращает

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

__set()source публичный

__set( string $name , mixed $object )

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

Параметры

строка $name

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

смешанный тип $object

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

__unset()source публичный

__unset( string $name )

Удаляет объект.

Параметры

строка $name

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

_checkDuplicate()source защищённый

_checkDuplicate( string $name , array $config )

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

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

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

Параметры

строка $name

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

массив $config

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

Выбрасывает

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

count()source публичный

count( )

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

Возвращает

целое число

Реализация

Countable::count()

get()source публичный

get( string $name )

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

Параметры

строка $name

Имя объекта.

Возвращает

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

getIterator()source публичный

getIterator( )

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

Возвращает

ArrayIterator

Реализация

IteratorAggregate::getIterator()

has()source публичный

has( string $name )

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

Параметры

строка $name

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

Возвращает

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

load()source публичный

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 публичный

loaded( )

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

Возвращает

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

normalizeArray()source public

normalizeArray( array $objects )

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

Параметры

массив $objects

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

Возвращает

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

reset()source public

reset( )

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

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

Возвращает

$this

set()source public

set( string $objectName , object $object )

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

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

Параметры

строка $objectName

Имя объекта, который нужно установить в реестре.

объект $object

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

Возвращает

$this