Класс Email

__clonesource public

__clone( )

Клонирование экземпляра ViewBuilder при клонировании объекта email.

__constructsource public

__construct( array|string|null $config null )

Конструктор

Параметры

массив|строка|null $config необязательный null

Массив конфигураций или строка для загрузки конфигураций из email.php

_addEmailsource protected

_addEmail( string $varName , string|array $email , string $name )

Добавление адреса электронной почты

Параметры

строка $varName

Имя свойства

строка|массив $email

Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name

Имя

Возвращает

mixed
$this

Выбрасывает

InvalidArgumentException
\InvalidArgumentException

_applyConfigsource protected

_applyConfig( string|array $config )

Применение конфигурации к экземпляру

Параметры

строка|массив $config

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

Выбрасывает

InvalidArgumentException
При использовании конфигурации, которой нет.

_attachFilessource protected

_attachFiles( string|null $boundary null )

Прикрепление файлов, которые не встроены, путём добавления содержимого файла внутри границ.

Параметры

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

Граница для использования. Если null, то по умолчанию $this->_boundary

Возвращает

array
Массив строк для добавления в сообщение

_attachInlineFilessource protected

_attachInlineFiles( string|null $boundary null )

Прикрепление встроенных файлов к сообщению.

Параметры

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

Граница для использования. Если null, то по умолчанию $this->_boundary

Возвращает

array
Массив строк для добавления в сообщение

_checkViewVarssource protected

_checkViewVars( mixed $item , string $key )

Итерация по хешу для очистки и нормализации.

Параметры

смешанный $item

Ссылка на значение переменной представления.

строка $key

Ключ переменной представления.

_constructTransportsource protected

_constructTransport( string $name )

Создание экземпляра транспорта из данных конфигурации.

Параметры

строка $name

Имя конфигурации транспорта для создания.

Возвращает

Cake\Mailer\AbstractTransport
\Cake\Mailer\AbstractTransport

Выбрасывает

InvalidArgumentException
Если конфигурация транспорта отсутствует или некорректна.

_createBoundarysource protected

_createBoundary( )

Создание уникального идентификатора границы.

_encodesource protected

_encode( string $text )

Кодирование указанной строки с использованием текущей кодировки символов.

Параметры

строка $text

Строка для кодирования

Возвращает

string
Закодированная строка

_encodeStringsource protected

_encodeString( string $text , string $charset )

Перевод строки в одну кодировку из другой, если значение App.encoding отличается, и функция mb_convert_encoding существует.

Параметры

строка $text

Текст, который нужно преобразовать

строка $charset

Целевая кодировка

Возвращает

string
строка

_formatAddresssource protected

_formatAddress( array $address )

Форматирование адресов

Если адрес содержит не буквенно-цифровые/пробельные символы, он будет заключён в кавычки, поскольку символы, такие как : и ,, известны тем, что вызывают проблемы в полях заголовков адресов.

Параметры

массив $address

Адреса для форматирования.

Возвращает

array
массив

_getContentTransferEncodingsource protected

_getContentTransferEncoding( )

Возвращает значение Content-Transfer Encoding, основанное на заданной кодировке символов.

Возвращает

string
строка

_getContentTypeCharsetsource protected

_getContentTypeCharset( )

Возвращает значение кодировки символов для Content-Type.

Проверяет типы падения/совместимости, которые включают обходные пути для устаревших японских наборов символов.

Возвращает

string
строка

_getTypessource protected

_getTypes( )

Получение типов текстовых тел, которые находятся в этом сообщении электронной почты.

Возвращает

array
Массив типов. Допустимые типы — 'текст' и 'html'

_logDeliverysource protected

_logDelivery( array $contents )

Регистрация доставки электронного сообщения.

Параметры

массив $contents

Содержимое с ключами 'заголовки' и 'сообщение'.

_readFilesource protected

_readFile( string $path )

Чтение содержимого файла и возвращение его в формате base64.

Параметры

строка $path

Абсолютный путь к файлу для чтения.

Возвращает

string
Содержимое файла в кодировке base64

_rendersource protected

_render( array $content )

Вывод тела электронного сообщения.

Параметры

массив $content

Содержимое для вывода.

Возвращает

array
Тело электронного сообщения, готовое к отправке

_renderTemplatessource protected

_renderTemplates( string $content )

Создаёт и устанавливает все свойства представления, необходимые для отрисовки шаблонизированных писем. Если шаблон не задан, функция возвращает $content в виде массива с типами текстового содержимого для письма.

Параметры

строка $content

Содержимое, переданное в send() в большинстве случаев.

Возвращает

array
Отрендеренное содержимое с ключами html и text.

_setEmailsource protected

_setEmail( string $varName , string|array $email , string $name )

Устанавливает адрес электронной почты

Параметры

строка $varName

Имя свойства

строка|массив $email

Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name

Имя

Возвращает

mixed
$this

Исключения

InvalidArgumentException
\InvalidArgumentException

_setEmailSinglesource protected

_setEmailSingle( string $varName , string|array $email , string $name , string $throwMessage )

Устанавливает только 1 адрес электронной почты

Параметры

строка $varName

Имя свойства

строка|массив $email

Строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

строка $name

Имя

строка $throwMessage

Сообщение об ошибке

Возвращает

mixed
$this

Исключения

InvalidArgumentException
\InvalidArgumentException

_validateEmailsource protected

_validateEmail( string $email )

Проверка адреса электронной почты

Параметры

строка $email

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

Исключения

InvalidArgumentException
Если адрес электронной почты не соответствует формату

_wrapsource protected

_wrap( string $message , integer $wrapLength Cake\Mailer\Email::LINE_LENGTH_MUST )

Обрамляет сообщение в соответствии со стандартом RFC 2822 - 2.1.1

Параметры

строка $message

Сообщение для обёртывания

целое число $wrapLength необязательно Cake\Mailer\Email::LINE_LENGTH_MUST

Длина строки

Возвращает

array
Обёрнутое сообщение

addAttachmentssource public

addAttachments( string|array $attachments )

Добавляет вложения

Параметры

строка|массив $attachments

Имя файла или массив имён файлов

Возвращает

mixed
$this

Исключения

InvalidArgumentException
\InvalidArgumentException

См. также

Cake\Mailer\Email::attachments()

addBccsource public

addBcc( string|array $email , string|null $name null )

Добавляет Bcc

Параметры

строка|массив $email

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

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

Имя

Возвращает

mixed
$this

addCcsource public

addCc( string|array $email , string|null $name null )

Добавляет Cc

Параметры

строка|массив $email

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

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

Имя

Возвращает

mixed
$this

addHeaderssource public

addHeaders( array $headers )

Добавляет заголовок сообщения

Параметры

массив $headers

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

Возвращает

mixed
$this

addTosource public

addTo( string|array $email , string|null $name null )

Добавляет получателя

Параметры

строка|массив $email

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

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

Имя

Возвращает

mixed
$this

attachmentssource public

attachments( string|array|null $attachments null )

Добавляет вложения к сообщению электронной почты

Вложения могут быть определены несколькими способами в зависимости от требуемого уровня контроля:

Прикрепление одного файла:

$email->attachments('path/to/file');

Прикрепление файла с другим именем файла:

$email->attachments(['custom_name.txt' => 'path/to/file.txt']);

Прикрепление файла и указание дополнительных свойств:

$email->attachments(['custom_name.png' => [
     'file' => 'path/to/file',
     'mimetype' => 'image/png',
     'contentId' => 'abc123',
     'contentDisposition' => false
   ]
]);

Прикрепление файла из строки и указание дополнительных свойств:

$email->attachments(['custom_name.png' => [
     'data' => file_get_contents('path/to/file'),
     'mimetype' => 'image/png'
   ]
]);

Ключ contentId позволяет указать встроенное вложение. В тексте письма можно использовать <img src="cid:abc123" /> для отображения изображения внутри.

Ключ contentDisposition позволяет отключить заголовок Content-Disposition, что может улучшить совместимость вложений с клиентами электронной почты Outlook.

Параметры

строка|массив|null $attachments необязательно null

Имя файла или массив имён файлов

Возвращает

array|$this
$this либо массив вложений при получении, либо $this при установке.

Исключения

InvalidArgumentException
\InvalidArgumentException

bccsource public

bcc( string|array|null $email null , string|null $name null )

Bcc

Параметры

строка|массив|null $email необязательно null

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

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

Имя

Возвращает

array|$this
$this

ccsource public

cc( string|array|null $email null , string|null $name null )

Cc

Параметры

строка|массив|null $email необязательно null

Null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

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

Имя

Возвращает

array|$this
$this

charsetsource public

charset( string|null $charset null )

Установщик/получатель набора символов

Параметры

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

Набор символов.

Возвращает

string
this->charset

configTransportsource public static

configTransport( string|array $key , array|Cake\Mailer\AbstractTransport|null $config null )

Добавление или чтение конфигурации транспорта.

Используйте этот метод для определения транспортов, которые будут использоваться в профилях доставки. После определения конфигурации вы не сможете ее изменить и должны использовать Email::dropTransport(), чтобы очистить конфигурацию.

При использовании массива данных конфигурации для каждого отправляемого сообщения будет создан новый транспорт. При использовании замыкания замыкание будет вычисляться для каждого сообщения.

Ключ className используется для определения класса, который будет использоваться для транспорта. Он может быть коротким именем или полным именем класса.

Параметры

string|array $key

Имя конфигурации для чтения/записи. Или массив с несколькими транспорты для установки.

array|Cake\Mailer\AbstractTransport|null $config необязательно null

Массив данных конфигурации или экземпляр транспорта.

Возвращает

array|null
null при установке или массив данных при чтении.

Выбрасывает

BadMethodCallException
При изменении существующей конфигурации.

configuredTransportsource public static

configuredTransport( )

Возвращает массив, содержащий конфигурации транспорта по имени.

Возвращает

array
Массив конфигураций.

createFromArraysource public

createFromArray( array $config )

Настраивает объект экземпляра электронной почты из сериализованной конфигурации.

Параметры

array $config

Массив конфигурации электронной почты.

Возвращает

Cake\Mailer\Email
Настроенный экземпляр электронной почты.

deliversource public static

deliver( string|array $to null , string $subject null , string|array $message null , string|array $transportConfig 'fast' , boolean $send true )

Статический метод для быстрого создания экземпляра \Cake\Mailer\Email

Параметры

string|array $to необязательно null

Адрес для отправки (см. Cake\Mailer\Email::to()). Если null, будет попытка использования 'to' из конфигурации транспорта.

string $subject необязательно null

Строка темы или null для использования 'subject' из конфигурации транспорта.

string|array $message необязательно null

Строка с сообщением или массив с переменными, которые будут использоваться в рендеринге.

string|array $transportConfig необязательно 'fast'

Строка для использования конфигурации из EmailConfig или массив с конфигурациями.

boolean $send необязательно true

Отправить электронное письмо или просто вернуть экземпляр предварительно настроенный.

Возвращает

Cake\Mailer\Email
Экземпляр Cake\Mailer\Email

Выбрасывает

InvalidArgumentException
\InvalidArgumentException

domainsource public

domain( string|null $domain null )

Домен как верхний уровень (часть после @)

Параметры

string|null $domain необязательно null

Ручное задание домена для рассылки по CLI.

Возвращает

string|$this
$this

dropTransportsource public static

dropTransport( string $key )

Удаление конфигурации транспорта.

Параметры

string $key

Имя транспорта для удаления.

emailFormatsource public

emailFormat( string|null $format null )

Формат электронной почты

Параметры

string|null $format необязательно null

Форматирующая строка.

Возвращает

string|$this
$this

Выбрасывает

InvalidArgumentException
\InvalidArgumentException

emailPatternsource public

emailPattern( string|boolean|null $regex false )

Установка/получение EmailPattern

Параметры

string|boolean|null $regex необязательно false

Шаблон для проверки адресов электронной почты, null для отмены шаблона и использования filter_var(), false или ничего для возврата текущего значения.

Возвращает

string|$this
$this

fromsource public

from( string|array|null $email null , string|null $name null )

Отправитель

Параметры

string|array|null $email необязательно null

null для получения, строка с адресом электронной почты, массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени).

string|null $name необязательно null

Имя.

Возвращает

array|$this
$this

Выбрасывает

InvalidArgumentException
\InvalidArgumentException

getHeaderssource public

getHeaders( array $include [] )

Получить список заголовков

Включает в себя:

• from
• replyTo
• readReceipt
• returnPath
• to
• cc
• bcc
• subject

Параметры

array $include необязательно []

Список заголовков.

Возвращает

array
массив

headerCharsetsource public

headerCharset( string|null $charset null )

Установка/получение HeaderCharset

Параметры

string|null $charset необязательно null

Кодировка символов.

Возвращает

string
this->charset

helperssource public

helpers( array|null $helpers null )

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

Параметры

array|null $helpers необязательно null

Список вспомогательных функций.

Возвращает

array|$this
$this

jsonSerializesource public

jsonSerialize( )

Сериализует объект электронной почты в значение, которое может быть нативно сериализовано и повторно использовано для клонирования этого экземпляра электронной почты.

У него есть определенные ограничения для viewVars, которые важно знать:
- ORM\Query выполняется и сохраняется как результат - SimpleXmlElements сохраняются как ассоциативный массив - Исключение сохраняется как строка - Ресурсы, \Closure и \PDO не поддерживаются.

Возвращает

array
Сериализуемый массив свойств конфигурации.

Выбрасывает

Exception
При невозможности правильной сериализации объекта view var.

Реализация

JsonSerializable::jsonSerialize()

messagesource public

message( string|null $type null )

Получить сгенерированное сообщение (используется классами транспорта).

Параметры

string|null $type необязательно null

Используйте константы MESSAGE_* или null для возврата полного сообщения в виде массива.

Возвращает

string|array
Строка, если есть тип, массив, если тип null

messageIdsource public

messageId( boolean|string|null $message null )

Идентификатор сообщения

Параметры

boolean|string|null $message необязательно null

True для генерации нового идентификатора сообщения, False для игнорирования (не отправлять в письме), Строка для установки идентификатора сообщения

Возвращает

boolean|string|$this
$this

Возбуждает

InvalidArgumentException
\InvalidArgumentException

profilesource public

profile( null|string|array $config null )

Получение/установка профиля конфигурации для использования в данном экземпляре.

Параметры

null|string|array $config необязательно null

Строка с именем конфигурации или массив с конфигурацией, или null для возвращения текущей конфигурации.

Возвращает

string|array|$this
$this

readReceiptsource public

readReceipt( string|array|null $email null , string|null $name null )

Получение подтверждения о прочтении (заголовок Disposition-Notification-To)

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null

Имя

Возвращает

array|$this
$this

Возбуждает

InvalidArgumentException
\InvalidArgumentException

replyTosource public

replyTo( string|array|null $email null , string|null $name null )

Reply-To

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null

Имя

Возвращает

array|$this
$this

Возбуждает

InvalidArgumentException
\InvalidArgumentException

resetsource public

reset( )

Сброс всех внутренних переменных для отправки нового письма.

Возвращает

mixed
$this

returnPathsource public

returnPath( string|array|null $email null , string|null $name null )

Обратный путь

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null

Имя

Возвращает

array|$this
$this

Возбуждает

InvalidArgumentException
\InvalidArgumentException

sendsource public

send( string|array|null $content null )

Отправить электронное письмо с указанным содержимым, шаблоном и макетом

Параметры

string|array|null $content необязательно null

Строка с сообщением или массив с сообщениями

Возвращает

array
массив

Возбуждает

BadMethodCallException
\BadMethodCallException

sendersource public

sender( string|array|null $email null , string|null $name null )

Отправитель

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null

Имя

Возвращает

array|$this
$this

Возбуждает

InvalidArgumentException
\InvalidArgumentException

serializesource public

serialize( )

Сериализация объекта Email.

Возвращает

string
строка

Реализация

Serializable::serialize()

setHeaderssource public

setHeaders( array $headers )

Устанавливает заголовки сообщения

Параметры

array $headers

Ассоциативный массив, содержащий заголовки для установки.

Возвращает

mixed
$this

subjectsource public

subject( string|null $subject null )

Получение/установка темы.

Параметры

string|null $subject необязательно null

Строка темы.

Возвращает

string|$this
$this

templatesource public

template( boolean|string $template false , boolean|string $layout false )

Шаблон и макет

Параметры

boolean|string $template необязательно false

Имя шаблона или null, чтобы не использовать

boolean|string $layout необязательно false

Имя макета или null, чтобы не использовать

Возвращает

array|$this
$this

themesource public

theme( string|null $theme null )

Тема для использования при рендеринге

Параметры

string|null $theme необязательно null

Имя темы.

Возвращает

string|$this
$this

tosource public

to( string|array|null $email null , string|null $name null )

Кому

Параметры

string|array|null $email необязательно null

Null для получения, Строка с адресом электронной почты, Массив с адресом электронной почты в качестве ключа, именем в качестве значения или адресом электронной почты в качестве значения (без имени)

string|null $name необязательно null

Имя

Возвращает

array|$this
$this

transportsource public

transport( string|Cake\Mailer\AbstractTransport|null $name null )

Получение/установка транспорта.

При установке транспорта вы можете использовать имя настроенного транспорта или предоставить созданный транспорт.

Параметры

string|Cake\Mailer\AbstractTransport|null $name необязательно null

Либо имя настроенного транспорта, либо экземпляр транспорта.

Возвращает

Cake\Mailer\AbstractTransport|$this
$this

Возбуждает

LogicException
Если выбранному транспорту не хватает метода отправки.
InvalidArgumentException
Если $name не является строкой или объектом.

unserializesource public

unserialize( string $data )

Десериализация объекта Email.

Параметры

string $data

Сериализованная строка.

Возвращает

Cake\Mailer\Email
Настроенный экземпляр электронной почты.

Реализация

Serializable::unserialize()

viewRendersource public

viewRender( string|null $viewClass null )

Класс представления для рендеринга

Параметры

string|null $viewClass необязательно null

Имя класса представления.

Возвращает

string|$this
$this

viewVarssource public

viewVars( array|null $viewVars null )

Переменные, которые нужно установить при отрисовке

Параметры

array|null $viewVars необязательно null

Переменные для установки в представлении.

Возвращает

array|$this
$this

configsource public static

config( string|array $key , array $config null )

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

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

Адаптеры не будут созданы до выполнения первой операции.

Использование

Предполагая, что имя класса — Cache, поддерживаются следующие сценарии:

Чтение конфигурационных данных обратно:

Cache::config('default');

Настройка движка кэша.

Cache::config('default', $settings);

Вставка сконструированного адаптера:

Cache::config('default', $instance);

Настройка нескольких адаптеров одновременно:

Cache::config($arrayOfConfig);

Параметры

string|array $key

Имя конфигурации или массив нескольких конфигураций.

array $config необязательно null

Массив данных конфигурации с именем => конфигурация адаптера.

Возвращает

array|null
Значение null при добавлении конфигурации или массив конфигурационных данных при чтении.

Выбрасывает

BadMethodCallException
При попытке изменить существующую конфигурацию.

configuredsource public static

configured( )

Возвращает массив, содержащий указанные конфигурации

Возвращает

array
Массив конфигураций.

dropsource public static

drop( string $config )

Удаляет сконструированный адаптер.

Если вы хотите изменить существующую конфигурацию, вы должны удалить её, изменить конфигурацию, а затем добавить её заново.

Если реализуемые объекты поддерживают объект $_registry, имя конфигурации также будет выгружено из реестра.

Параметры

string $config

Существующая конфигурация, которую вы хотите удалить.

Возвращает

boolean
Успешность удаления, возвращает false, когда конфигурация не существует.

dsnClassMapsource public static

dsnClassMap( array $map null )

Возвращает или обновляет карту классов DSN для этого класса

Параметры

array $map необязательно null

Добавления/изменения в карту классов для применения

Возвращает

array
массив

parseDsnsource public static

parseDsn( string $dsn )

Разбирает DSN в корректную конфигурацию подключения

Этот метод позволяет задать DSN, используя формат, аналогичный используемому PEAR::DB. Следующее является примером его использования:

$dsn = 'mysql://user:pass@localhost/database?';
$config = ConnectionManager::parseDsn($dsn);

$dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS';
$config = Log::parseDsn($dsn);

$dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null';
$config = Email::parseDsn($dsn);

$dsn = 'file:///?className=\My\Cache\Engine\FileEngine';
$config = Cache::parseDsn($dsn);

$dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/';
$config = Cache::parseDsn($dsn);

Для всех классов значение scheme устанавливается как значение и className, если не указано иное.

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

Параметры

string $dsn

Строка DSN для преобразования в массив конфигурации

Возвращает

array
Массив конфигурации для хранения после анализа DSN

Выбрасывает

InvalidArgumentException
Если в качестве параметра не передана строка

createViewsource public

createView( string|null $viewClass null )

Создаёт экземпляр класса представления на основе текущей конфигурации.

Параметры

string|null $viewClass необязательно null

Необязательное именованное имя класса View для создания экземпляра.

Возвращает

Cake\View\View
\Cake\View\View

Выбрасывает

Cake\View\Exception\MissingViewException
Если класс представления не был найден.

setsource public

set( string|array $name , string|array|null|boolean $value null )

Сохраняет переменную или ассоциативный массив переменных для использования внутри шаблона.

Параметры

string|array $name

Строка или массив данных.

string|array|null|boolean $value необязательно null

Значение в случае, если $name — строка (тогда она работает как ключ). Не используется, если $name — ассоциативный массив, в противном случае служит значениями для ключей $name.

Возвращает

mixed
$this

viewBuildersource public

viewBuilder( )

Получить используемый билдер представлений.

Возвращает

Cake\View\ViewBuilder
\Cake\View\ViewBuilder

viewOptionssource public

viewOptions( string|array|null $options null , boolean $merge true )

Получить/установить допустимые параметры представления в свойстве _validViewOptions объекта. Свойство создается как пустой массив, если оно не установлено. Если вызывается без каких-либо параметров, она вернёт текущий список допустимых параметров представления. Смотрите createView().

Параметры

string|array|null $options необязательно null

строка или массив строк для добавления к _validViewOptions.

boolean $merge необязательно true

Следует ли слить с существующими допустимыми параметрами представления или перезаписать их. По умолчанию true.

Возвращает

array
Обновленные параметры представления в виде массива.

null

[]

[]

null

[]

['UTF-8', 'SHIFT_JIS']

'EmailConfig'

[
    'ISO-2022-JP-MS' => 'ISO-2022-JP'
]

null

[
    'debug' => 'Cake\Mailer\Transport\DebugTransport',
    'mail' => 'Cake\Mailer\Transport\MailTransport',
    'smtp' => 'Cake\Mailer\Transport\SmtpTransport',
]

'text'

['text', 'html', 'both']

Cake\Mailer\Email::EMAIL_PATTERN

[]

[]

''

[]

true

[]

[]

[]

[]

[]

''

''

[]

null

[]

'utf-8'

null

[]

null

[]