Класс AbstractTransport
Абстрактный транспорт для отправки электронных писем
- Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait
Прямые известные подклассы
Cake\Mailer\Transport\DebugTransport, Cake\Mailer\Transport\MailTransport, Cake\Mailer\Transport\SmtpTransportПодробное описание методов
__constructsource public
__construct( array $config [] )
Конструктор
Параметры
- массив
$configнеобязательный [] - Параметры конфигурации.
_headersToStringsource protected
_headersToString( array $headers , string $eol "\r\n" )
Помощь в преобразовании заголовков в строку
Параметры
- массив
$headers - Заголовки в формате ключ => значение
- строка
$eolнеобязательный "\r\n" - Строка конца строки.
Возвращает
stringстрока
sendsource abstract public
send( Cake\Mailer\Email $email )
Отправка письма
Параметры
-
Cake\Mailer\Email$email - Экземпляр письма.
Возвращает
arrayмассив
Используемые методы из Cake\Core\InstanceConfigTrait
_configDeletesource protected
_configDelete( string $key )
Удалить один ключ конфигурации
Параметры
- строка
$key - Ключ для удаления.
Выбрасывает
Cake\Core\Exception\Exceptionесли попытка перезаписать существующую конфигурацию
_configReadsource protected
_configRead( string|null $key )
Чтение переменной конфигурации
Параметры
- строка|null
$key - Ключ для чтения.
Возвращает
mixedсмешанный
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Запись переменной конфигурации
Параметры
- строка|массив
$key - Ключ для записи.
- смешанный
$value - Значение для записи.
- логическое|строка
$mergeнеобязательный false - Истина для рекурсивного слияния, 'поверхностное' для простого слияния, ложь для перезаписи, по умолчанию ложь.
Выбрасывает
Cake\Core\Exception\Exceptionесли попытка перезаписи существующей конфигурации
configsource 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']);
Параметры
- строка|массив|null
$keyнеобязательный null - Ключ для получения/установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательный null - Значение для установки.
- логическое
$mergeнеобязательный true - Необходимо ли рекурсивно сливать или перезаписывать существующую конфигурацию, по умолчанию истинно.
Возвращает
mixedЗначение конфигурации, которое читается, или сам объект при операциях записи.
Выбрасывает
Cake\Core\Exception\ExceptionПри попытке установить недопустимый ключ.
configShallowsource public
configShallow( string|array $key , mixed|null $value null )
Слить предоставленную конфигурацию с существующей конфигурацией. В отличие от config(), которая выполняет рекурсивное слияние для вложенных ключей, этот метод выполняет простое слияние.
Установка определенного значения:
$this->config('key', $value);
Установка вложенного значения:
$this->config('some.nested.key', $value);
Обновление нескольких настроек конфигурации одновременно:
$this->config(['one' => 'value', 'another' => 'value']);
Параметры
- строка|массив
$key - Ключ для установки или полный массив конфигураций.
- смешанный|null
$valueнеобязательный null - Значение для установки.
Возвращает
mixed$this Объект сам по себе.
Резюме свойств
Используемые свойства из Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected логическое
Установлено ли свойство конфигурации значениями по умолчанию
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Mailer.AbstractTransport.html