Класс TestEmailTransport
TestEmailTransport
Установите это как транспорт электронной почты для захвата писем для последующих утверждений
Краткое описание свойств
- $_config protected
arrayКонфигурация выполнения
- $_configInitialized protected
boolУказывает, была ли конфигурация свойства уже настроена по умолчанию
- $_defaultConfig protected
arrayКонфигурация по умолчанию для этого класса
Краткое описание методов
-
__construct() public
Конструктор
-
_configDelete() protected
Удаляет один ключ конфигурации.
-
_configRead() protected
Читает ключ конфигурации.
-
_configWrite() protected
Записывает ключ конфигурации.
-
checkRecipient() protected
Проверяет, что установлен хотя бы один заголовок назначения.
-
clearMessages() public static
Очищает список отправленных писем.
-
configShallow() public
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от
config(), которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение. -
getConfig() public
Возвращает конфигурацию.
-
getConfigOrFail() public
Возвращает конфигурацию для указанного ключа.
-
getMessages() public static
Получает отправленные письма.
-
replaceAllTransports() public static
Заменяет все текущие транспортные средства этим.
-
send() public
Сохраняет письмо для последующих проверок.
-
setConfig() public
Устанавливает конфигурацию.
Подробное описание методов
__construct() public
__construct(array $config = [])
Конструктор
Параметры
-
array$config optional Параметры конфигурации.
_configDelete() protected
_configDelete(string $key): void
Удаляет один ключ конфигурации.
Параметры
-
string$key Ключ для удаления.
Возвращает
voidИсключение
Cake\Core\Exception\CakeExceptionпри попытке перезаписать существующую конфигурацию
_configRead() protected
_configRead(string|null $key): mixed
Читает ключ конфигурации.
Параметры
-
string|null$key Ключ для чтения.
Возвращает
mixed_configWrite() protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): void
Записывает ключ конфигурации.
Параметры
-
string|array$key Ключ для записи.
-
mixed$value Значение для записи.
-
bool|string$merge optional True для рекурсивного объединения, 'shallow' для простого объединения, false для перезаписи, по умолчанию false.
Возвращает
voidИсключение
Cake\Core\Exception\CakeExceptionпри попытке перезаписи существующей конфигурации
checkRecipient() protected
checkRecipient(Cake\Mailer\Message $message): void
Проверяет, что установлен хотя бы один заголовок назначения.
Параметры
-
Cake\Mailer\Message$message Экземпляр сообщения.
Возвращает
voidИсключение
Cake\Core\Exception\CakeExceptionЕсли хотя бы один из заголовков to, cc или bcc не указан.
clearMessages() public static
clearMessages(): void
Очищает список отправленных писем.
Возвращает
voidconfigShallow() public
configShallow(string|array $key, mixed|null $value = null): $this
Объединяет предоставленную конфигурацию с существующей конфигурацией. В отличие от config() , которая выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
Установление определенного значения:
$this->configShallow('key', $value); Установление вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
-
string|array$key Ключ для установки или полный массив конфигураций.
-
mixed|null$value optional Значение для установки.
Возвращает
$thisgetConfig() public
getConfig(string|null $key = null, mixed $default = null): mixed
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определенного значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
-
string|null$key optional Ключ для получения или null для всей конфигурации.
-
mixed$default optional Возвращаемое значение, если ключ не существует.
Возвращает
mixedgetConfigOrFail() public
getConfigOrFail(string $key): mixed
Возвращает конфигурацию для указанного ключа.
Значение конфигурации для этого ключа должно существовать, оно никогда не может быть null.
Параметры
-
string$key Ключ для получения.
Возвращает
mixedИсключение
InvalidArgumentExceptiongetMessages() public static
getMessages(): Cake\Mailer\Message[]
Получает отправленные письма.
Возвращает
Cake\Mailer\Message[]replaceAllTransports() public static
replaceAllTransports(): void
Заменяет все текущие транспортные средства этим.
Возвращает
voidsend() public
send(Cake\Mailer\Message $message): array
Сохраняет письмо для последующих проверок.
Параметры
-
Cake\Mailer\Message$message Сообщение
Возвращает
arraysetConfig() public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this
Устанавливает конфигурацию.
Использование
Установление определенного значения:
$this->setConfig('key', $value); Установление вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких настроек конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
-
string|array$key Ключ для установки или полный массив конфигураций.
-
mixed|null$value optional Значение для установки.
-
bool$merge optional Выполнять рекурсивное объединение или перезаписывать существующую конфигурацию, по умолчанию true.
Возвращает
$thisИсключение
Cake\Core\Exception\CakeExceptionПри попытке установки недопустимого ключа.
Подробное описание свойств
$_config protected
Конфигурация во время выполнения
Тип
array$_configInitialized protected
Указывает, была ли конфигурация свойства уже настроена по умолчанию
Тип
bool$_defaultConfig protected
Конфигурация по умолчанию для этого класса
Тип
array
© 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.TestSuite.TestEmailTransport.html
