Класс Email

__clone()source public

__clone( )

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

__construct()source public

__construct( array|string|null $config null )

Конструктор

Параметры

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

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

_addEmail()source protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

Возвращает

$this

Выбрасывает

InvalidArgumentException

_applyConfig()source protected

_applyConfig( string|array $config )

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

Параметры

string|array $config

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

Выбрасывает

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

_attachFiles()source protected

_attachFiles( string|null $boundary null )

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

Параметры

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

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

Возвращает

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

_attachInlineFiles()source protected

_attachInlineFiles( string|null $boundary null )

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

Параметры

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

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

Возвращает

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

_checkViewVars()source protected

_checkViewVars( mixed $item , string $key )

Перебирает хэш для очистки и нормализации.

Параметры

mixed $item

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

string $key

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

_constructTransport()source protected

_constructTransport( string $name )

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

Параметры

string $name

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

Возвращает

Cake\Mailer\AbstractTransport

Выбрасывает

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

_createBoundary()source protected

_createBoundary( )

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

_encode()source protected

_encode( string $text )

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

Параметры

string $text

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

Возвращает

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

_encodeString()source protected

_encodeString( string $text , string $charset )

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

Параметры

string $text

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

string $charset

целевой набор символов

Возвращает

string

_formatAddress()source protected

_formatAddress( array $address )

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

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

Параметры

array $address

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

Возвращает

array

_getContentTransferEncoding()source protected

_getContentTransferEncoding( )

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

Возвращает

string

_getContentTypeCharset()source protected

_getContentTypeCharset( )

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

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

Возвращает

string

_getTypes()source protected

_getTypes( )

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

Возвращает

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

_logDelivery()source protected

_logDelivery( array $contents )

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

Параметры

array $contents

Содержимое с ключами 'headers' и 'message'.

_readFile()source protected

_readFile( string $path )

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

Параметры

string $path

Полный путь к файлу для чтения.

Возвращает

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

_render()source protected

_render( array $content )

Отображение тела электронного письма.

Параметры

array $content

Содержимое для отображения

Возвращает

array
Тело электронного письма, готовое к отправке

_renderTemplates()source protected

_renderTemplates( string $content )

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

Параметры

string $content

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

Возвращает

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

_setEmail()source protected

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

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

Параметры

string $varName

Имя свойства

string|array $email

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

string $name

Имя

Возвращает

$this

Выбрасывает

InvalidArgumentException

_setEmailSingle()source protected

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

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

Параметры

строка $varName

Имя свойства

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

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

строка $name

Имя

строка $throwMessage

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

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

$this

Исключения

InvalidArgumentException

_validateEmail()source protected

_validateEmail( string $email )

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

Параметры

строка $email

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

Исключения

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

_wrap()source protected

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

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

Параметры

строка $message

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

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

Длина строки

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

массив
Оборачиваемое сообщение

addAttachments()source public

addAttachments( string|array $attachments )

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

Параметры

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

Строка с именем файла или массив с именами файлов

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

$this

Исключения

InvalidArgumentException

См. также

\Cake\Mailer\Email::attachments()

addBcc()source public

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

Добавить Bcc

Параметры

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

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

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

Имя

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

$this

addCc()source public

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

Добавить Cc

Параметры

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

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

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

Имя

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

$this

addHeaders()source public

addHeaders( array $headers )

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

Параметры

массив $headers

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

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

$this

addTo()source public

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

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

Параметры

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

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

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

Имя

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

$this

attachments()source 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

Строка с именем файла или массив с именами файлов

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

массив|Cake\Mailer\Email
$this Либо массив вложений при получении, либо $this при установке.

Исключения

InvalidArgumentException

bcc()source public

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

Bcc

Параметры

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

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

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

Имя

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

массив|Cake\Mailer\Email
$this

cc()source public

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

Cc

Параметры

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

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

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

Имя

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

массив|Cake\Mailer\Email
$this

charset()source public

charset( string|null $charset null )

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

Параметры

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

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

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

строка
this->charset

configTransport()source public static

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

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

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

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

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

Параметры

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

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

массив|Cake\Mailer\AbstractTransport|null $config необязательно null

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

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

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

Исключения

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

configuredTransport()source public static

configuredTransport( )

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

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

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

createFromArray()source public

createFromArray( array $config )

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

Параметры

массив $config

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

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

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

deliver()source public static

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

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

Параметры

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

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

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

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

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

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

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

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

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

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

Возвращает

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

Выбрасывает

InvalidArgumentException

domain()source public

domain( string|null $domain null )

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

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

dropTransport()source public static

dropTransport( string $key )

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

Параметры

string $key

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

emailFormat()source public

emailFormat( string|null $format null )

Формат электронного письма

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

emailPattern()source public

emailPattern( string|boolean|null $regex false )

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

Параметры

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

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

Возвращает

string|Cake\Mailer\Email
$this

from()source public

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

Отправитель

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

getHeaders()source public

getHeaders( array $include [] )

Получение списка заголовков

Включает:

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

Параметры

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

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

Возвращает

array

headerCharset()source public

headerCharset( string|null $charset null )

Установка/получение кодировки символов заголовка

Параметры

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

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

Возвращает

string
this->charset

helpers()source public

helpers( array|null $helpers null )

Помощники, используемые в рендеринге

Параметры

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

Список помощников.

Возвращает

array|Cake\Mailer\Email
$this

jsonSerialize()source public

jsonSerialize( )

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

У него есть определенные ограничения для viewVars, о которых полезно знать:

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

Возвращает

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

Выбрасывает

Exception
Когда объект view var не может быть должным образом сериализован.

Реализация

JsonSerializable::jsonSerialize()

message()source public

message( string|null $type null )

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

Параметры

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

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

Возвращает

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

messageId()source public

messageId( boolean|string|null $message null )

Message-ID

Параметры

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

True для генерации нового Message-ID, False для игнорирования (не отправлять в электронном письме), Строка для установки Message-ID

Возвращает

boolean|string|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

profile()source public

profile( null|string|array $config null )

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

Параметры

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

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

Возвращает

string|array|Cake\Mailer\Email
$this

readReceipt()source 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|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

replyTo()source public

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

Reply-To

Параметры

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

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

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

Имя

Возвращает

array|Cake\Mailer\Email
$this

Выбрасывает

InvalidArgumentException

reset()source public

reset( )

Сбросить все внутренние переменные, чтобы отправить новое письмо.

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

$this

returnPath()source public

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

Адрес возврата

Параметры

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

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

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

Имя

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

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

send()source public

send( string|array|null $content null )

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

Параметры

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

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

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

array

Исключения

BadMethodCallException

sender()source public

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

Отправитель

Параметры

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

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

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

Имя

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

array|Cake\Mailer\Email
$this

Исключения

InvalidArgumentException

serialize()source public

serialize( )

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

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

string

Реализация

Serializable::serialize()

setHeaders()source public

setHeaders( array $headers )

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

Параметры

array $headers

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

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

$this

subject()source public

subject( string|null $subject null )

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

Параметры

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

Строка темы.

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

string|Cake\Mailer\Email
$this

template()source public

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

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

Параметры

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

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

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

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

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

array|Cake\Mailer\Email
$this

theme()source public

theme( string|null $theme null )

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

Параметры

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

Имя темы.

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

string|Cake\Mailer\Email
$this

to()source public

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

Получатель

Параметры

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

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

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

Имя

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

array|Cake\Mailer\Email
$this

transport()source public

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

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

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

Параметры

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

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

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

Cake\Mailer\AbstractTransport|Cake\Mailer\Email
$this

Исключения

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

unserialize()source public

unserialize( string $data )

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

Параметры

string $data

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

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

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

Реализация

Serializable::unserialize()

viewRender()source public

viewRender( string|null $viewClass null )

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

Параметры

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

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

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

string|Cake\Mailer\Email
$this

viewVars()source public

viewVars( array|null $viewVars null )

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

Параметры

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

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

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

array|Cake\Mailer\Email
$this

config()source public static

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

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

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

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

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

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

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

Cache::config('default');

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

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

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

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

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

Cache::config($arrayOfConfig);

Параметры

string|array $key

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

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

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

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

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

Исключения

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

configured()source public static

configured( )

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

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

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

drop()source public static

drop( string $config )

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

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

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

Параметры

string $config

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

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

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

dsnClassMap()source public static

dsnClassMap( array $map null )

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

Параметры

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

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

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

array

parseDsn()source 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
Если в качестве параметра не передана строка

createView()source public

createView( string|null $viewClass null )

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

Параметры

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

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

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

Cake\View\View

Исключения

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

set()source public

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

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

Параметры

string|array $name

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

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

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

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

$this

viewBuilder()source public

viewBuilder( )

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

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

Cake\View\ViewBuilder

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

[
    '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']

self::EMAIL_PATTERN

[]

[]

''

[]

true

[]

[]

[]

[]

[]

''

''

[]

null

[]

'utf-8'

null