Класс EmailComponent

__construct()source public

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

Конструктор

Параметры

ComponentCollection $collection

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

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

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

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

_findFiles()source protected

_findFiles( string $attachment )

Поиск указанного вложения в списке путей к файлам

Параметры

строка $attachment

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

Возвращает

_formatAddresses()source protected

_formatAddresses( array $addresses )

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

Параметры

массив $addresses

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

Возвращает

_formatAttachFiles()source protected

_formatAttachFiles( )

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

Возвращает

_strip()source protected

_strip( string $value , boolean $message false )

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

Параметры

строка $value

Значение для удаления

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

Устанавливается в true, чтобы указать основной контент сообщения

Возвращает

initialize()source public

initialize( Controller $controller )

Инициализировать компонент

Параметры

Controller $controller

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

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

reset()source public

reset( )

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

send()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

__get()source public

__get( string $name )

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

Параметры

строка $name

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

Возвращает

beforeRedirect()source public

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

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

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

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

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

Параметры

Controller $controller

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

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

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

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

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

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

Необходимо ли завершить сценарий.

Возвращает

Ссылка

beforeRender()source public

beforeRender( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

shutdown()source public

shutdown( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

startup()source public

startup( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

log()source 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().

Возвращает

requestAction()source 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 необязательно массив()

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

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

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

toString()source public

toString( )

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

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