Класс TestEmailTransport
TestEmailTransport
Установите это как транспорт электронной почты, чтобы захватить электронные письма для последующих утверждений
- Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
-
Cake\TestSuite\TestEmailTransport
См.:
Cake\TestSuite\EmailTraitРасположение: TestSuite/TestEmailTransport.php
Унаследованные свойства
Краткое описание методов
- Очищает список отправленных электронных писем
- Получает отправленные электронные письма
- Заменяет все текущие транспортные средства этим
- send() publicСохраняет электронное письмо для последующих утверждений
Подробное описание методов
getEmails()source public static
getEmails( )
Получает отправленные электронные письма
Возвращает
Cake\Mailer\Email[]replaceAllTransports()source public static
replaceAllTransports( )
Заменяет все текущие транспортные средства этим
send()source public
send( Cake\Mailer\Email $email )
Сохраняет электронное письмо для последующих утверждений
Параметры
-
Cake\Mailer\Email$email - Электронное письмо
Возвращает
booleanУнаследованные методы от Cake\Mailer\AbstractTransport
__construct()source public
__construct( array $config = [] )
Конструктор
Параметры
- массив
$configнеобязательно [] - Параметры конфигурации.
_headersToString()source protected
_headersToString( array $headers , string $eol = "\r\n" )
Помощь в преобразовании заголовков в строку
Параметры
- массив
$headers - Заголовки в формате ключ => значение
- строка
$eolнеобязательно "\r\n" - Строка конца строки.
Возвращает
строкаМетоды, используемые из Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Удаляет один ключ конфигурации.
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
_configRead()source protected
_configRead( string|null $key )
Считывает ключ конфигурации.
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
смешанный_configWrite()source protected
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Записывает ключ конфигурации.
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный
$value - Значение для записи.
- boolean|строка
$mergeнеобязательно false Истинно, чтобы рекурсивно слить, «поверхностный» для простого слияния, ложно, чтобы перезаписать, по умолчанию ложно.
Выбрасывает
Cake\Core\Exception\Exceptionесли пытаетесь перезаписать существующую конфигурацию
config()source public устарело
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Получает/устанавливает конфигурацию.
Использование
Чтение всей конфигурации:
$this->config();
Чтение определенного значения:
$this->config('key'); Чтение вложенного значения:
$this->config('some.nested.key'); Установка определенного значения:
$this->config('key', $value); Установка вложенного значения:
$this->config('some.nested.key', $value); Обновление нескольких параметров конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Устарело
3.4.0 использовать setConfig()/getConfig() вместо этого.Параметры
- строка|массив|null
$keyнеобязательно null - Ключ для получения/установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
смешанныйЗначение конфигурации, которое считывается, или сам объект при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить некорректный ключ.
configShallow()source public
configShallow( string|array $key , mixed|null $value = null )
Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определенного значения:
$this->configShallow('key', $value); Установка вложенного значения:
$this->configShallow('some.nested.key', $value); Обновление нескольких параметров конфигурации одновременно:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
Возвращает
$this
getConfig()source public
getConfig( string|null $key = null , mixed $default = null )
Возвращает конфигурацию.
Использование
Чтение всей конфигурации:
$this->getConfig();
Чтение определенного значения:
$this->getConfig('key'); Чтение вложенного значения:
$this->getConfig('some.nested.key'); Чтение со значением по умолчанию:
$this->getConfig('some-key', 'default-value'); Параметры
- строка|null
$keyнеобязательно null - Ключ для получения или null для всей конфигурации.
- смешанный
$defaultнеобязательно null - Значение по умолчанию, если ключ не найден.
Возвращает
смешанныйЗначение конфигурации, которое считывается.
setConfig()source public
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Устанавливает конфигурацию.
Использование
Установка определенного значения:
$this->setConfig('key', $value); Установка вложенного значения:
$this->setConfig('some.nested.key', $value); Обновление нескольких параметров конфигурации одновременно:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или весь массив конфигураций.
- смешанный|null
$valueнеобязательно null - Значение для установки.
- boolean
$mergeнеобязательно true - Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.
Возвращает
$this
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить некорректный ключ.
© 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/3.7/class-Cake.TestSuite.TestEmailTransport.html