Класс TransportRegistry

Регистр объектов для транспортов почтовых отправлений.

Пространство имён: Cake\Mailer

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

$_loaded protected

object[]

Карта загруженных объектов.

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

__debugInfo() public

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

Предоставление публичного доступа для чтения к загруженным объектам
__isset() public

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

Устанавливает объект.
__unset() public

Удаляет объект.
_checkDuplicate() protected

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

Создаёт экземпляр транспорта почтовых отправлений.
_resolveClassName() protected

Разрешение имени класса транспорта почтовых отправлений.
_throwMissingClassError() protected

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

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

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

Возвращает итератор массива.
has() public

Проверка на загрузку заданного объекта.
load() public

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

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

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

Очистка загруженных экземпляров в реестре.
set() public

Установка объекта непосредственно в реестр по имени.
unload() public

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

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

__debugInfo() public

__debugInfo(): array

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

Возвращает

array

__get() public

__get(string $name): object|null

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

Параметры

string $name: Имя свойства для чтения

Возвращает

object|null

__isset() public

__isset(string $name): bool

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

Параметры

string $name: Имя проверяемого объекта.

Возвращает

bool

__set() public

__set(string $name, object $object): void

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

Параметры

string $name: Имя свойства для установки.
object $object: Объект для установки.

Возвращает

void

__unset() public

__unset(string $name): void

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

Параметры

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

Возвращает

void

_checkDuplicate() protected

_checkDuplicate(string $name, array $config): void

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

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

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

Параметры

string $name: Имя псевдонима в реестре.
array $config: Данные конфигурации для нового экземпляра.

Возвращает

void

Исключение

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

_create() protected

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

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

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

Параметры

string|object $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array $config: Массив настроек для использования с кэш-движком.

Возвращает

Cake\Mailer\AbstractTransport

Исключение

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

_resolveClassName() protected

_resolveClassName(string $class): string|null

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

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

Параметры

string $class: Частичное имя класса для разрешения или экземпляр транспорта.

Возвращает

string|null

_throwMissingClassError() protected

_throwMissingClassError(string $class, string|null $plugin): void

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

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

Параметры

string $class: Отсутствующее имя класса.
string|null $plugin: Плагин, в котором отсутствует кэш.

Возвращает

void

Исключение

BadMethodCallException

count() public

count(): int

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

Возвращает

int

get() public

get(string $name): object

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

Параметры

string $name: Имя объекта.

Возвращает

object

Исключение

RuntimeException
Если не загружен или не найден.

getIterator() public

getIterator(): Traversable

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

Возвращает

Traversable

has() public

has(string $name): bool

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

Параметры

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

Возвращает

bool

load() public

load(string $name, array $config = []): mixed

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

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

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

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

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

Параметры

string $name: Имя/класс объекта для загрузки.
array $config optional: Дополнительные параметры для использования при загрузке объекта.

Возвращает

mixed

Исключение

Exception
Если класс не найден.

loaded() public

loaded(): string[]

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

Возвращает

string[]

normalizeArray() public

normalizeArray(array $objects): array[]

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

Параметры

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

Возвращает

array[]

reset() public

reset(): $this

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

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

Возвращает

$this

set() public

set(string $name, object $object): $this

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

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

Параметры

string $name: Имя объекта для установки в реестре.
object $object: экземпляр для хранения в реестре

Возвращает

$this

unload() public

unload(string $name): $this

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

Если у этого реестра есть менеджер событий, объект также будет отвязан от любых событий.

Параметры

string $name: Имя адаптера.

Возвращает

$this

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

`$_loaded` protected

Карта загруженных объектов.

Тип

object[]

© 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/4.2/class-Cake.Mailer.TransportRegistry.html