Класс EmailComponent

__constructисточник public

__construct( ComponentCollection $collection , array $settings array() )

Конструктор

Параметры

ComponentCollection $collection

A ComponentCollection, который этот компонент может использовать для ленивой загрузки своих компонентов

массив $settings необязательно массив()

Массив параметров конфигурации.

Переопределяет

Component::__construct()

_findFilesисточник protected

_findFiles( string $attachment )

Находит указанное вложение в списке путей к файлам

Параметры

строка $attachment

Имя файла вложения для поиска

Возвращает

string|null
Путь к найденному файлу

_formatAddressesисточник protected

_formatAddresses( array $addresses )

Форматирует адреса в массив с электронной почтой в качестве ключа и псевдонима в качестве значения

Параметры

массив $addresses

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

Возвращает

array
массив

_formatAttachFilesисточник protected

_formatAttachFiles( )

Форматирует массив вложений

Возвращает

array
массив

_stripисточник protected

_strip( string $value , boolean $message false )

Удаляет определенные элементы (например, bcc:, to:, %0a) из заданного значения. Помогает предотвратить инъекцию заголовков/манипулирование содержимым пользователя.

Параметры

строка $value

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

булево $message необязательно ложь

Установите в значение true, чтобы указать основное содержимое сообщения

Возвращает

string
Очищенное значение

initializeисточник public

initialize( Controller $controller )

Инициализация компонента

Параметры

Controller $controller

Инициализируемый контроллер

Переопределяет

Component::initialize()

resetисточник public

reset( )

Сбрасывает все внутренние переменные EmailComponent, чтобы можно было отправить новое электронное письмо.

sendисточник public

send( string|array $content null , string $template null , string $layout null )

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

Параметры

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

Либо массив строк текста, либо строка с содержимым. Если вы рендерите шаблон, эта переменная будет отправлена в шаблоны как $content

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

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

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

Макет для использования для оформления тела электронного письма

Возвращает

boolean
Успех

__getисточник public

__get( string $name )

Магический метод для ленивой загрузки $components.

Параметры

строка $name

Имя компонента для получения.

Возвращает

mixed
Объект компонента или null.

beforeRedirectисточник public

beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )

Вызывается перед Controller::redirect(). Позволяет заменить URL, на который будет произведено перенаправление, новым URL. Возвращаемое значение этого метода может быть массивом или строкой.

Если возвращаемое значение — массив и содержит ключ 'url', вы также можете предоставить следующее:

• status Код состояния для перенаправления
• exit Необходимо ли завершить выполнение сценария после перенаправления.

Если ваш ответ — строка или массив, не содержащий ключа 'url', он будет использован в качестве нового URL для перенаправления.

Параметры

Controller $controller

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

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

Либо строка, либо массив URL, на который происходит перенаправление.

целое число $status необязательно null

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

булево $exit необязательно true

Будет ли выполнение сценария завершено.

Возвращает

array|null
Либо массив, либо null.

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRedirect

beforeRenderисточник public

beforeRender( Controller $controller )

Вызывается перед Controller::beforeRender(), перед загрузкой класса представления и перед Controller::render()

Параметры

Controller $controller

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

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::beforeRender

shutdownисточник public

shutdown( Controller $controller )

Вызывается после Controller::render() и перед выводом данных в браузер.

Параметры

Controller $controller

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

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::shutdown

startupисточник public

startup( Controller $controller )

Вызывается после Controller::beforeFilter() и перед выполнением действия контроллера

Параметры

Controller $controller

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

Ссылка

http://book.cakephp.org/2.0/ru/controllers/components.html#Component::startup

_mergeVarssource protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства этого объекта $property со свойствами в определении $class. Значение свойства этого класса для свойства будет объединено поверх значения $class.

Это предоставляет часть "DRY-магии" CakePHP. Если вы хотите это отключить, переопределите этот метод как пустую функцию.

Параметры

массив $properties

Имя свойств для объединения.

строка $class

Класс для объединения свойства с ним.

логическое значение $normalize необязательно true

Установите в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_setsource protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будет устанавливать только свойства, которые являются частью объявления класса.

Параметры

массив $properties необязательно array()

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

_stopsource protected

_stop( integer|string $status 0 )

Остановить выполнение текущего сценария. Оборачивает exit(), что упрощает тестирование.

Параметры

целое число/строка $status необязательно 0

см. http://php.net/exit для значений

dispatchMethodsource public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет объектно-ориентированную оболочку для call_user_func_array

Параметры

строка $method

Имя вызываемого метода

массив $params необязательно array()

Список параметров для использования при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

logsource public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. Для получения дополнительной информации о записи в журналы см. CakeLog::write().

Параметры

строка $msg

Сообщение журнала

целое число $type необязательно LOG_ERR

Константа типа ошибки. Определена в app/Config/core.php.

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

Область(и), в которой создается сообщение журнала. Для получения дополнительной информации о зонах ведения журнала см. CakeLog::config().

Возвращает

boolean
Успешность записи в журнал

requestActionsource public

requestAction( string|array $url , array $extra array() )

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

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse().

Передача данных POST и GET

Данные POST и GET могут быть смоделированы в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет моделировать данные POST.

Параметры

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

Строковый или основанный на массиве URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

массив $extra необязательно array()

Если массив содержит ключ "return", он устанавливает AutoRender в значение true. Также может быть использован для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

mixed
Логическое значение true или false при успехе/неудачи, или содержимое отрисованного действия, если в $extra задан ключ 'return'.

toStringsource public

toString( )

Преобразование объекта в строку. Каждый класс может переопределять этот метод по мере необходимости.

Возвращает

string
Имя этого класса

null

null

array()

array()

array()

'utf-8'

null

'mail'

array()

null

array()

null

'default'

PHP_EOL

true

null

null

null

'text'

array()

null

null

null

null

'CakePHP Email Component'

array()

array()

array()