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

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

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

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

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

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

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

Выполнить выход из скрипта.

Возвращает

Ссылка

beforeRender()source public

beforeRender( Controller $controller )

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

Параметры

Controller $controller

Контроллер с компонентами для переднего отображения

Ссылка

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

Параметры

целое число|строка $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 необязательно array()

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

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

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

toString()source public

toString( )

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

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