Класс MailTransport

_mail()source protected

_mail( string $to , string $subject , string $message , string $headers , string|null $params = null )

Оборачивает внутреннюю функцию mail() и генерирует исключение вместо ошибок, если что-то пойдёт не так

Параметры

строка $to

адресат письма

строка $subject

тема письма

строка $message

тело письма

строка $headers

заголовки письма

строка|null $params необязательно null

дополнительные параметры для отправки почты

Исключения

Cake\Network\Exception\SocketException
если почту невозможно отправить

send()source public

send( Cake\Mailer\Email $email )

Отправка почты

Параметры

Cake\Mailer\Email $email

Cake Email

Возвращает

массив

__construct()source public

__construct( array $config = [] )

Конструктор

Параметры

массив $config необязательно []

Параметры конфигурации.

_headersToString()source protected

_headersToString( array $headers , string $eol = "\r\n" )

Помогает преобразовать заголовки в строку

Параметры

массив $headers

Заголовки в формате ключ => значение

строка $eol необязательно "\r\n"

Строка конца строки.

Возвращает

строка

_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

True для рекурсивной склейки, 'shallow' для простой склейки, false для перезаписи, по умолчанию 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

Рекурсивно склеить или перезаписать существующую конфигурацию, по умолчанию 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, если ключ не существует.

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

Рекурсивно склеить или перезаписать существующую конфигурацию, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\Exception
При попытке установить неверный ключ.