Класс FlashComponent

__call()source public

__call( string $name , array $args )

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

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

Параметры

строка $name

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

массив $args

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

Исключения

__construct()source public

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

Конструктор

Параметры

ComponentCollection $collection

Объект ComponentCollection

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

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

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

set()source public

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

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

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

Параметры:

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

Параметры

строка $message

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

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

Массив параметров.

__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

Ссылка

initialize()source public

initialize( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

shutdown()source public

shutdown( Controller $controller )

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

Параметры

Controller $controller

Контроллер с компонентами для завершения работы

Ссылка

startup()source public

startup( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

_mergeVars()source protected

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

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

Это обеспечивает некоторую 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(), что упрощает тестирование.

Параметры

integer|string $status необязательный 0

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

dispatchMethod()source public

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

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

Параметры

string $method

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

array $params необязательный array()

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

Возвращает

log()source public

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

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

Параметры

string $msg

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

integer $type необязательный LOG_ERR

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

null|string|array $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.

Параметры

string|array $url

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

array $extra необязательный array()

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

Возвращает

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

toString()source public

toString( )

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

Возвращает