Spec-Zone.ru › CakePHP 3.8

Класс TestEmailTransport

TestEmailTransport

Установите это как транспорт электронной почты для захвата писем для последующих утверждений

Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
Расширенный Cake\Mailer\Transport\DebugTransport
Расширенный Cake\TestSuite\TestEmailTransport
Пространство имен: Cake\TestSuite
См.: Cake\TestSuite\EmailTrait
Расположение: TestSuite/TestEmailTransport.php

Наследуемые свойства

  • _defaultConfig _config, _configInitialized

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

  • clearEmails() public static
    Очищает список отправленных писем
  • getEmails() public static
    Получает отправленные письма
  • replaceAllTransports() public static
    Заменяет все текущие транспортные средства этим
  • send() public
    Хранит письмо для последующих утверждений

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

clearEmails()source public static

clearEmails( )

Очищает список отправленных писем

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
Письмо

Возвращает

массив

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

Cake\Mailer\Transport\DebugTransport::send()

Наследуемые методы из 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
Значение для записи.
логическое|строка $merge необязательно false

Истина для рекурсивного объединения, «поверхностное» для простого объединения, ложь для перезаписи, по умолчанию ложь.

Выбрасывает

Cake\Core\Exception\Exception
если пытаетесь перезаписать существующую конфигурацию

config()source public deprecated

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
Значение для установки.
логическое $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
Значение по умолчанию, возвращаемое, когда ключ не существует.

Возвращает

смешанное
Данные конфигурации по указанному ключу или null, если ключ не существует.
END_OF_DOCUMENT_MARKER ```

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']);

Параметры

string|array $key
Ключ для установки или массив с полными настройками.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Признак рекурсивного слияния или перезаписи существующей конфигурации, по умолчанию 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.8/class-Cake.TestSuite.TestEmailTransport.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API