Класс RequestHandlerComponent

__construct()source public

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

Конструктор. Парсит принимаемые типы контента, указанные клиентом через HTTP_ACCEPT

Параметры

ComponentCollection $collection

Объект ComponentCollection.

массив $settings optional array()

Массив настроек.

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

Component::__construct()

_setExtension()source protected

_setExtension( )

accepts()source public

accepts( string|array $type null )

addInputType()source public

addInputType( string $type , array $handler )

Добавить новый тип входных данных. Картированные типы входных данных автоматически преобразуются компонентом RequestHandlerComponent во время обратного вызова startup().

Параметры

строка $type

Псевдоним типа, который преобразуется, например, json

массив $handler

Массив обработчика для типа. Первый индекс должен быть обратным вызовом обработки, все остальные аргументы — дополнительные параметры для обработчика.

Исключения

CakeException

beforeRedirect()source public

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

Обрабатывает (имитирует) перенаправления для Ajax-запросов с помощью requestAction(). Изменяет $_POST и $_SERVER['REQUEST_METHOD'], чтобы имитировать новый GET-запрос.

Параметры

Controller $controller

Ссылка на контроллер

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

Строка или массив, содержащие местоположение перенаправления

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

HTTP-код статуса для перенаправления

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

Выход из скрипта, по умолчанию true.

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

Component::beforeRedirect()

beforeRender()source public

beforeRender( Controller $controller )

Проверяет, можно ли считать ответ другим в соответствии с заголовками запроса и заголовками кеширования ответа. Если он не изменялся, процесс рендеринга пропускается. И клиент получит пустой ответ с заголовком «304 Not Modified».

Параметры

Controller $controller

Экземпляр контроллера.

Возвращает

логическое значение
False, если процесс рендеринга должен быть прерван.

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

Component::beforeRender()

convertXml()source public

convertXml( string $xml )

Вспомогательный метод для разбора входных данных xml, из-за отсутствия анонимных функций он находится здесь.

Параметры

строка $xml

XML-строка.

Возвращает

массив
Данные xml-массива

getAjaxVersion()source public

getAjaxVersion( )

Получает версию Prototype, если вызов — Ajax, в противном случае пустую строку. Библиотека Prototype устанавливает специальный заголовок HTTP «Версия Prototype».

Возвращает

строка|логическое значение
При Ajax версии прототипа компонента, вызвавшего запрос, в противном случае false

getClientIP()source public

getClientIP( boolean $safe true )

Получает удалённый IP-адрес клиента

Устарело

3.0.0 Используйте $this->request->clientIp() в вашем контроллере вместо этого.

Параметры

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

Используйте безопасный = false, если вы считаете, что пользователь может манипулировать заголовком HTTP_CLIENT_IP. Установка $safe = false также проверит HTTP_X_FORWARDED_FOR

Возвращает

строка
IP-адрес клиента

getReferer()source public

getReferer( )

Получает имя сервера, с которого был выполнен данный запрос

Устарело

3.0.0 Используйте $this->request->referer() в вашем контроллере вместо этого

Возвращает

строка
Адрес сервера

initialize()source public

initialize( Controller $controller )

Проверяет, был ли расширение файла проанализирован маршрутизатором, или если HTTP_ACCEPT_TYPE соответствует только одному типу контента с поддерживаемыми расширениями. Если между поддерживаемыми типами контента и расширениями, и запрошенными типами MIME существует только один совпадающий тип, RequestHandler::$ext устанавливается на это значение.

Параметры

Controller $controller

Ссылка на контроллер

См. также

Router::parseExtensions()

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

Component::initialize()

isAjax()source public

isAjax( )

Возвращает true, если текущий HTTP-запрос является Ajax, в противном случае false

Устарело

3.0.0 Используйте $this->request->is('ajax') вместо этого.

Возвращает

логическое значение
True, если вызов Ajax

isAtom()source public

isAtom( )

Возвращает true, если текущий вызов принимает ответ Atom, в противном случае false

Возвращает

логическое значение
True, если клиент принимает ответ RSS

isDelete()source public

isDelete( )

Возвращает true, если текущий вызов — запрос DELETE.

Устарело

3.0.0 Используйте $this->request->is('delete'); в вашем контроллере.

Возвращает

boolean
True, если вызов является DELETE

isFlash()source public

isFlash( )

Возвращает true, если текущий HTTP-запрос поступает от клиента на основе Flash.

Устарело

3.0.0 Используйте $this->request->is('flash') вместо этого.

Возвращает

boolean
True, если вызов от Flash

isGet()source public

isGet( )

Возвращает true, если текущий вызов — запрос GET.

Устарело

3.0.0 Используйте $this->request->is('get'); в вашем контроллере.

Возвращает

boolean
True, если вызов является GET

isMobile()source public

isMobile( )

Возвращает true, если строка user agent соответствует мобильному веб-браузеру или если клиент принимает WAP-контент.

Возвращает

boolean
True, если user agent — мобильный веб-браузер

isPost()source public

isPost( )

Возвращает true, если текущий вызов — запрос POST.

Устарело

3.0.0 Используйте $this->request->is('post'); в вашем контроллере.

Возвращает

boolean
True, если вызов является POST

isPut()source public

isPut( )

Возвращает true, если текущий вызов — запрос PUT.

Устарело

3.0.0 Используйте $this->request->is('put'); в вашем контроллере.

Возвращает

boolean
True, если вызов является PUT

isRss()source public

isRss( )

Возвращает true, если текущий вызов принимает ответ RSS, в противном случае — false.

Возвращает

boolean
True, если клиент принимает ответ RSS

isSSL()source public

isSSL( )

Возвращает true, если текущий запрос проходит по протоколу HTTPS, в противном случае — false.

Устарело

3.0.0 Используйте $this->request->is('ssl') вместо этого.

Возвращает

boolean
True, если вызов проходит по HTTPS

isWap()source public

isWap( )

Возвращает true, если клиент принимает WAP-контент

Возвращает

boolean

isXml()source public

isXml( )

Возвращает true, если текущий вызов принимает ответ XML, в противном случае false

Возвращает

boolean
True, если клиент принимает ответ XML

mapAlias()source public

mapAlias( string|array $alias )

Преобразует псевдоним типа содержимого в MIME-тип(ы)

Параметры

string|array $alias

Псевдоним содержимого для преобразования в тип содержимого. Или массив псевдонимов для преобразования.

Возвращает

string|null

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

mapType()source public

mapType( string|array $cType )

Преобразует тип содержимого в псевдоним

Устарело

3.0.0 Используйте $this->response->mapType() в вашем контроллере вместо этого.

Параметры

string|array $cType

Строка или массив типов содержимого.

Возвращает

string|array
Псевдонимы для указанных типов.

prefers()source public

prefers( string|array $type null )

Определяет предпочитаемые типы содержимого клиента. Если нет параметров, возвращается единственный тип содержимого, который клиент, скорее всего, предпочитает. Если $type — массив, возвращается первый элемент массива, который принимает клиент. Предпочтения определяются главным образом расширением файла, проанализированным маршрутизатором, если он указан, и во вторую очередь списком типов содержимого, предоставленным в HTTP_ACCEPT.

Параметры

string|array $type optional null

Необязательный массив «дружественных» имен типов содержимого, например, 'html', 'xml', 'js' и т. д.

Возвращает

mixed

Если $type равен null или не указан, возвращается первый тип содержимого в списке в соответствии с предпочтениями. Если предоставлен один тип, возвращается boolean, если этот тип предпочтительнее. Если предоставлен массив типов, возвращается первый предпочтительный тип. Если тип не указан, возвращается первый предпочтительный тип.

См. также

RequestHandlerComponent::setContent()

renderAs()source public

renderAs( Controller $controller , string $type , array $options array() )

Устанавливает пути шаблонов и макетов для типа содержимого, определенного $type.

Использование:

Отобразить ответ как ответ «ajax».

$this->RequestHandler->renderAs($this, 'ajax');

Отобразить ответ как файл xml и принудительно сохранить результат как файл для скачивания.

$this->RequestHandler->renderAs($this, 'xml', array('attachment' => 'myfile.xml');

Параметры

Controller $controller

Ссылка на объект контроллера

string $type

Тип ответа (например: «ajax»)

array $options optional array()

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

См. также

RequestHandlerComponent::setContent()
RequestHandlerComponent::respondAs()

requestedWith()source public

requestedWith( string|array $type null )

Определяет тип содержимого данных, отправленных клиентом (например, в запросе POST).

Параметры

string|array $type optional null

Может быть null, строкой, именем типа или массивом типов

Возвращает

mixed

Если указан один тип, возвращается boolean. Если тип не указан, возвращается сопоставленное значение CONTENT_TYPE. Если указан массив, возвращается первый тип в типе запроса.

respondAs()source public

respondAs( string|array $type , array $options array() )

Устанавливает заголовок ответа на основе имени индекса отображения типов. Это оболочка нескольких методов, доступных в CakeResponse. Также позволяет использовать псевдонимы типов содержимого.

Параметры

string|array $type

Дружественное имя типа, например, 'html' или 'xml', или полный тип содержимого, например, 'application/x-shockwave'.

array $options optional array()

Если $type — дружественное имя типа, связанное с несколькими типами содержимого, $index используется для выбора типа содержимого.

Возвращает

boolean

Возвращает false, если заданное в $type дружественное имя типа не существует в таблице типов или если заголовок Content-type уже был установлен этим методом.

См. также

RequestHandlerComponent::setContent()

responseType()source public

responseType( )

Возвращает текущий тип ответа (заголовок Content-type) или null, если псевдоним не существует

Возвращает

mixed

Строковый псевдоним типа содержимого или тип содержимого в сыром виде, если таблица псевдонимов не существует, в противном случае null

setContent()source public

setContent( string $name , string|array $type null )

Добавляет/устанавливает тип(ы) содержимого для данного имени. Этот метод позволяет сопоставлять типы содержимого с дружественными псевдонимами (или расширениями), что позволяет RequestHandler автоматически отвечать на запросы этого типа в методе startup.

Устарело

3.0.0 Используйте $this->response->type() вместо этого.

Параметры

string $name

Имя типа содержимого, например, «html», «xml», «css»

string|array $type optional null

Тип содержимого или массив типов содержимого, назначенные имени, например, «text/html» или «application/xml»

startup()source public

startup( Controller $controller )

Метод startup компонента RequestHandler позволяет реализовать несколько автоматических действий, связанных с определением свойств HTTP-запроса, включая:

• Отключение отображения макета для Ajax-запросов (на основе заголовка HTTP_X_REQUESTED_WITH)
• Если Router::parseExtensions() включен, тип макета и шаблона изменяются на основе проанализированного расширения или заголовка Accept-Type. Например, если запрашивается controller/action.xml, путь к представлению становится app/View/Controller/xml/action.ctp. Также если controller/action запрашивается с Accept-Type: application/xml в заголовках, путь к представлению станет app/View/Controller/xml/action.ctp. Типы макета и шаблона будут переключаться только на MIME-типы, распознанные CakeResponse. Если вам нужно объявить дополнительные MIME-типы, вы можете сделать это, используя CakeResponse::type() в методе вашего контроллера beforeFilter().
• Если существует помощник с тем же именем, что и расширение, он добавляется к контроллеру.
• Если расширение относится к типу, понятому RequestHandler, он установит этот тип содержимого в заголовке ответа.
• Если XML-данные отправлены через POST, данные анализируются в XML-объект, который назначается свойству $data контроллера, которое затем можно сохранить в объекте модели.

Параметры

Controller $controller

Ссылка на контроллер

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

Component::startup()

viewClassMap()source public

viewClassMap( array|string $type null , array $viewClass null )

Геттер/сеттер для viewClassMap

Параметры

array|string $type optional null

Строка типа или массив с форматом array('type' => 'viewClass') для сопоставления одного или нескольких

array $viewClass optional null

Класс представления, используемый для типа без View в конце

Возвращает

array|string
Возвращает viewClass, когда указана только строка $type, в противном случае массив viewClassMap

__get()source public

__get( string $name )

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

Параметры

string $name

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

Возвращает

mixed
Объект Component или null.

shutdown()source public

shutdown( Controller $controller )

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

Параметры

Controller $controller

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

Ссылка

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

_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

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

mixed
Возвращает результат вызова метода

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

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

boolean
Успешность записи в журнал

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 и именованных/переданных аргументов.

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

mixed

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

toString()source public

toString( )

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

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

строка
Имя этого класса

array(
    'json' => array('json_decode', true)
)

null

array(
    'json' => 'Json',
    'xml' => 'Xml'
)

'ajax'

true

null