Класс TransportRegistry

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

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

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

$_loaded protected

array<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<string, mixed>

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

Возвращает

array<string, mixed>

__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<string, mixed> $config): void

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

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

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

Параметры

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

Возвращает

void

Выбрасывает

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

_create() protected

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

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

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

Параметры

object|string $class: Имя класса или объект для создания.
string $alias: Псевдоним объекта.
array<string, mixed> $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<string, mixed> $config = []): mixed

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

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

Пример с {@link \Cake\Controller\Component::$components}. Можно задать псевдоним объекта, установив ключ 'className', например:

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

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

Параметры

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

Возвращает

mixed

Выбрасывает

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

loaded() public

loaded(): array<string>

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

Возвращает

array<string>

normalizeArray() public

normalizeArray(array $objects): array<string, array>

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

Параметры

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

Возвращает

array<string, 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

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

Тип

array<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.3/class-Cake.Mailer.TransportRegistry.html