Класс FlashComponent

__callисходный код public

__call( string $name , array $args )

Магический метод для подробных методов flash, основанных на именах элементов.

Например: $this->Flash->success('My message') будет использовать элемент success.ctp в app/View/Element/Flash для рендеринга сообщения flash.

Параметры

строка $name

Имя элемента для использования.

массив $args

Параметры, передаваемые при вызове FlashComponent::set().

Исключения

InternalErrorException
Если отсутствует сообщение flash.

__constructисходный код public

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

Конструктор

Параметры

ComponentCollection $collection

Объект ComponentCollection

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

Настройки, переданные через контроллер

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

Component::__construct()

setисходный код public

set( string $message , array $options array() )

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

В вашем контроллере: $this->Flash->set('Это было сохранено');

Параметры:

• key Ключ для установки в сессии Flash
• element Элемент, используемый для рендеринга сообщения flash. По умолчанию 'default'.
• params Массив переменных, доступных при использовании элемента

Параметры

строка $message

Сообщение для flash. Если экземпляр Exception, будет использовано сообщение об исключении, а код будет установлен в параметры.

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

Массив опций.

__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

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

строка|массив $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

initializeисходный код public

initialize( Controller $controller )

Вызывается перед Controller::beforeFilter().

Параметры

Controller $controller

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

Ссылка

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

shutdownисходный код public

shutdown( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

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

startupисходный код public

startup( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

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

_mergeVarsисходный код protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setисходный код protected

_set( array $properties array() )

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

Параметры

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

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

_stopисходный код 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
Имя этого класса

array(
    'key' => 'flash',
    'element' => 'default',
    'params' => array(),
)

array()

array()

array()