Spec-Zone.ru › CakePHP 3.3

Класс AbstractTransport

Абстрактный транспорт для отправки почты

Cake\Mailer\AbstractTransport использует Cake\Core\InstanceConfigTrait

Прямые подклассы

  • Cake\Mailer\Transport\DebugTransport
  • Cake\Mailer\Transport\MailTransport
  • Cake\Mailer\Transport\SmtpTransport
Абстрактный
Пространство имен: Cake\Mailer
Расположение: Mailer/AbstractTransport.php

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

  • $_defaultConfig protected
    array
    Конфигурация по умолчанию для этого класса

Унаследованные свойства

  • _config, _configInitialized

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

  • __construct() public
    Конструктор
  • _headersToString() protected
    Помощник для преобразования заголовков в строку
  • send() abstract public
    Отправить письмо

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

__construct()source public

__construct( array $config [] )

Конструктор

Параметры

array $config необязательно []
Параметры конфигурации.

_headersToString()source protected

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

Помощник для преобразования заголовков в строку

Параметры

array $headers
Заголовки в формате ключ => значение
string $eol необязательно "\r\n"
Строка окончания строки.

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

строка

send()source abstract public

send( Cake\Mailer\Email $email )

Отправить письмо

Параметры

Cake\Mailer\Email $email
Экземпляр почтового сообщения.

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

массив

Используемые методы из Cake\Core\InstanceConfigTrait

_configDelete()source protected

_configDelete( string $key )

Удаление одного ключа конфигурации

Параметры

string $key
Ключ для удаления.

Исключения

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

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации

Параметры

string|null $key
Ключ для чтения.

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

смешанное

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации

Параметры

string|array $key
Ключ для записи.
mixed $value
Значение для записи.
boolean|string $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']);

Параметры

string|array|null $key необязательно null
Ключ для получения/установки или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.
boolean $merge необязательно true
Выполнять ли рекурсивное слияние или перезапись существующей конфигурации, по умолчанию истинно.

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

смешанное
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

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

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

Параметры

string|array $key
Ключ для установки или полный массив конфигураций.
mixed|null $value необязательно null
Значение для установки.

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


$this Сам объект.

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

$_defaultConfigsource

protected массив

Конфигурация по умолчанию для этого класса

[]

© 2005–2017 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.3/class-Cake.Mailer.AbstractTransport.html

Spec-Zone.ru

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