Класс RequestHandlerComponent

__construct()source public

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

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

Параметры

ComponentCollection $collection

Объект ComponentCollection.

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

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

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

Component::__construct()

_setExtension()source protected

_setExtension( )

accepts()source public

accepts( string|array $type null )

addInputType()source public

addInputType( string $type , array $handler )

Добавить новый тип входных данных. Картированные типы входных данных автоматически преобразуются компонентом RequestHandler во время обратного вызова 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

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

Возвращает

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

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

Component::beforeRender()

convertXml()source public

convertXml( string $xml )

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

Параметры

строка $xml

Строка XML.

Возвращает

массив
Данные XML в формате массива

getAjaxVersion()source public

getAjaxVersion( )

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

Возвращает

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

getClientIP()source public

getClientIP( boolean $safe true )

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

Устаревшее

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

Параметры

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

Используйте safe = 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') в вашем контроллере.

Возвращает

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

isFlash()source public

isFlash( )

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

Устаревшее

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

Возвращает

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

isGet()source public

isGet( )

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

Устаревшее

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

Возвращает

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

isMobile()source public

isMobile( )

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

Возвращает

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

isPost()source public

isPost( )

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

Устаревшее

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

Возвращает

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

isPut()source public

isPut( )

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

Устаревшее

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

Возвращает

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

isRss()source public

isRss( )

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

Возвращает

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

isSSL()source public

isSSL( )

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

Устаревшее

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

Возвращает

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

isWap()source public

isWap( )

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

Возвращает

логическое значение

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

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

Ссылка

https://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 при успехе/неудачи или содержимое отрисованного действия, если 'return' установлен в $extra.

toString()source public

toString( )

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

Возвращает

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

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

null

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

'ajax'

true

null