Класс 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

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

массив $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( )

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

Возвращает