RequestDataCollector
class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
Properties
| protected | $data | from DataCollector | |
| protected | $controllers |
Methods
| serialize() | from DataCollector | |
| unserialize($data) | from DataCollector | |
| Data | cloneVar(mixed $var) Converts the variable into a serializable Data instance. | from DataCollector |
| callable[] | getCasters() | from DataCollector |
| __construct() | ||
| collect(Request $request, Response $response, Exception $exception = null) Collects data for the given Request and Response. | ||
| lateCollect() Collects data as late as possible. | ||
| reset() Resets this data collector to its initial state. | ||
| getMethod() | ||
| getPathInfo() | ||
| getRequestRequest() | ||
| getRequestQuery() | ||
| getRequestHeaders() | ||
| getRequestServer($raw = false) | ||
| getRequestCookies($raw = false) | ||
| getRequestAttributes() | ||
| getResponseHeaders() | ||
| getResponseCookies() | ||
| getSessionMetadata() | ||
| getSessionAttributes() | ||
| getFlashes() | ||
| getContent() | ||
| getContentType() | ||
| getStatusText() | ||
| getStatusCode() | ||
| getFormat() | ||
| getLocale() | ||
| getDotenvVars() | ||
| string | getRoute() Gets the route name. | |
| getIdentifier() | ||
| array | getRouteParams() Gets the route parameters. | |
| array|string | getController() Gets the parsed controller. | |
| array|bool | getRedirect() Gets the previous request attributes. | |
| getForwardToken() | ||
| onKernelController(FilterControllerEvent $event) | ||
| onKernelResponse(FilterResponseEvent $event) | ||
| static array | getSubscribedEvents() Returns an array of event names this subscriber wants to listen to. | |
| string | getName() Returns the name of the collector. | |
| array|string | parseController(mixed $controller) Parse a controller. |
Details
serialize()
unserialize($data)
Parameters
| $data |
protected Data cloneVar(mixed $var)
Converts the variable into a serializable Data instance.
This array can be displayed in the template using the VarDumper component.
Parameters
| mixed | $var |
Return Value
| Data |
protected callable[] getCasters()
Return Value
| callable[] | The casters to add to the cloner |
__construct()
collect(Request $request, Response $response, Exception $exception = null)
Collects data for the given Request and Response.
Parameters
| Request | $request | |
| Response | $response | |
| Exception | $exception |
lateCollect()
Collects data as late as possible.
reset()
Resets this data collector to its initial state.
getMethod()
getPathInfo()
getRequestRequest()
getRequestQuery()
getRequestHeaders()
getRequestServer($raw = false)
Parameters
| $raw |
getRequestCookies($raw = false)
Parameters
| $raw |
getRequestAttributes()
getResponseHeaders()
getResponseCookies()
getSessionMetadata()
getSessionAttributes()
getFlashes()
getContent()
getContentType()
getStatusText()
getStatusCode()
getFormat()
getLocale()
getDotenvVars()
string getRoute()
Gets the route name.
The _route request attributes is automatically set by the Router Matcher.
Return Value
| string | The route |
getIdentifier()
array getRouteParams()
Gets the route parameters.
The _route_params 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 |
getForwardToken()
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 |
protected array|string parseController(mixed $controller)
Parse a controller.
Parameters
| mixed | $controller | The controller to parse |
Return Value
| array|string | An array of controller data or a simple string |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.html