Класс 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

Возвращаемое значение

массив

__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

Значение для записи.

булево|строка $merge дополнительно false

Истина для рекурсивной слияния, 'shallow' для простого слияния, ложь для перезаписи, по умолчанию ложь.

Исключения

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

Значение для установки.

булево $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

Значение для установки.

булево $merge дополнительно true

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

Возвращаемое значение

$this

Исключения

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