W3cubDocs

RequestDataCollector

class RequestDataCollector extends RequestDataCollector implements EventSubscriberInterface

RequestDataCollector.

Methods

	serialize()	from DataCollector
	unserialize($data)	from DataCollector
	__construct()	from RequestDataCollector
	collect(Request $request, Response $response, Exception $exception = null) Collects data for the given Request and Response.
	getMethod()	from RequestDataCollector
	getPathInfo()	from RequestDataCollector
	getRequestRequest()	from RequestDataCollector
	getRequestQuery()	from RequestDataCollector
	getRequestHeaders()	from RequestDataCollector
	getRequestServer()	from RequestDataCollector
	getRequestCookies()	from RequestDataCollector
	getRequestAttributes()	from RequestDataCollector
	getResponseHeaders()	from RequestDataCollector
	getSessionMetadata()	from RequestDataCollector
	getSessionAttributes()	from RequestDataCollector
	getFlashes()	from RequestDataCollector
	getContent()	from RequestDataCollector
	getContentType()	from RequestDataCollector
	getStatusText()	from RequestDataCollector
	getStatusCode()	from RequestDataCollector
	getFormat()	from RequestDataCollector
	getLocale()	from RequestDataCollector
string	getRoute() Gets the route name.	from RequestDataCollector
array	getRouteParams() Gets the route parameters.	from RequestDataCollector
array\|string	getController() Gets the parsed controller.	from RequestDataCollector
array\|bool	getRedirect() Gets the previous request attributes.	from RequestDataCollector
	onKernelController(FilterControllerEvent $event)
	onKernelResponse(FilterResponseEvent $event)	from RequestDataCollector
static array	getSubscribedEvents() Returns an array of event names this subscriber wants to listen to.	from RequestDataCollector
string	getName() Returns the name of the collector.
array\|bool	getForward() Gets the parsed forward controller.

Details

serialize()

unserialize($data)

Parameters

$data

__construct()

collect(Request $request, Response $response, Exception $exception = null)

Collects data for the given Request and Response.

Parameters

Request	$request	A Request instance
Response	$response	A Response instance
Exception	$exception	An Exception instance

getMethod()

getPathInfo()

getRequestRequest()

getRequestQuery()

getRequestHeaders()

getRequestServer()

getRequestCookies()

getRequestAttributes()

getResponseHeaders()

getSessionMetadata()

getSessionAttributes()

getFlashes()

getContent()

getContentType()

getStatusText()

getStatusCode()

getFormat()

getLocale()

string getRoute()

Gets the route name.

The _route request attributes is automatically set by the Router Matcher.

Return Value

string

The route

array getRouteParams()

Gets the route parameters.

The routeparams request attributes is automatically set by the RouterListener.

Return Value

array

The parameters

array|string getController()

Gets the parsed controller.

Return Value

array|string

The controller as a string or array of data with keys 'class', 'method', 'file' and 'line'

array|bool getRedirect()

Gets the previous request attributes.

Return Value

array|bool

A legacy array of data from the previous redirection response or false otherwise

onKernelController(FilterControllerEvent $event)

Parameters

FilterControllerEvent

$event

onKernelResponse(FilterResponseEvent $event)

Parameters

FilterResponseEvent

$event

static array getSubscribedEvents()

Returns an array of event names this subscriber wants to listen to.

The array keys are event names and the value can be:

The method name to call (priority defaults to 0)
An array composed of the method name to call and the priority
An array of arrays composed of the method names to call and respective priorities, or 0 if unset

For instance:

array('eventName' => 'methodName')
array('eventName' => array('methodName', $priority))
array('eventName' => array(array('methodName1', $priority), array('methodName2')))

Return Value

array

The event names to listen to

string getName()

Returns the name of the collector.

Return Value

string

The collector name

array|bool getForward()

Gets the parsed forward controller.

Return Value

array|bool

An array with keys 'token' the forward profile token, and 'controller' the parsed forward controller, false otherwise

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Bundle/FrameworkBundle/DataCollector/RequestDataCollector.html