4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\HttpKernel\DataCollector;
14 use Symfony\Component\HttpFoundation\ParameterBag;
15 use Symfony\Component\HttpFoundation\Request;
16 use Symfony\Component\HttpFoundation\Response;
17 use Symfony\Component\HttpKernel\KernelEvents;
18 use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
19 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
22 * RequestDataCollector.
24 * @author Fabien Potencier <fabien@symfony.com>
26 class RequestDataCollector extends DataCollector implements EventSubscriberInterface
28 protected $controllers;
30 public function __construct()
32 $this->controllers = new \SplObjectStorage();
38 public function collect(Request $request, Response $response, \Exception $exception = null)
40 $responseHeaders = $response->headers->all();
41 foreach ($response->headers->getCookies() as $cookie) {
42 $responseHeaders['set-cookie'][] = (string) $cookie;
45 // attributes are serialized and as they can be anything, they need to be converted to strings.
46 $attributes = array();
47 foreach ($request->attributes->all() as $key => $value) {
48 if ('_route' === $key && is_object($value)) {
49 $attributes[$key] = $this->varToString($value->getPath());
50 } elseif ('_route_params' === $key) {
51 // we need to keep route params as an array (see getRouteParams())
52 foreach ($value as $k => $v) {
53 $value[$k] = $this->varToString($v);
55 $attributes[$key] = $value;
57 $attributes[$key] = $this->varToString($value);
63 $content = $request->getContent();
64 } catch (\LogicException $e) {
65 // the user already got the request content as a resource
69 $sessionMetadata = array();
70 $sessionAttributes = array();
72 if ($request->hasSession()) {
73 $session = $request->getSession();
74 if ($session->isStarted()) {
75 $sessionMetadata['Created'] = date(DATE_RFC822, $session->getMetadataBag()->getCreated());
76 $sessionMetadata['Last used'] = date(DATE_RFC822, $session->getMetadataBag()->getLastUsed());
77 $sessionMetadata['Lifetime'] = $session->getMetadataBag()->getLifetime();
78 $sessionAttributes = $session->all();
79 $flashes = $session->getFlashBag()->peekAll();
83 $statusCode = $response->getStatusCode();
86 'format' => $request->getRequestFormat(),
87 'content' => $content,
88 'content_type' => $response->headers->get('Content-Type', 'text/html'),
89 'status_text' => isset(Response::$statusTexts[$statusCode]) ? Response::$statusTexts[$statusCode] : '',
90 'status_code' => $statusCode,
91 'request_query' => $request->query->all(),
92 'request_request' => $request->request->all(),
93 'request_headers' => $request->headers->all(),
94 'request_server' => $request->server->all(),
95 'request_cookies' => $request->cookies->all(),
96 'request_attributes' => $attributes,
97 'response_headers' => $responseHeaders,
98 'session_metadata' => $sessionMetadata,
99 'session_attributes' => $sessionAttributes,
100 'flashes' => $flashes,
101 'path_info' => $request->getPathInfo(),
102 'controller' => 'n/a',
103 'locale' => $request->getLocale(),
106 if (isset($this->data['request_headers']['php-auth-pw'])) {
107 $this->data['request_headers']['php-auth-pw'] = '******';
110 if (isset($this->data['request_server']['PHP_AUTH_PW'])) {
111 $this->data['request_server']['PHP_AUTH_PW'] = '******';
114 if (isset($this->data['request_request']['_password'])) {
115 $this->data['request_request']['_password'] = '******';
118 foreach ($this->data as $key => $value) {
119 if (!is_array($value)) {
122 if ('request_headers' === $key || 'response_headers' === $key) {
123 $value = array_map(function ($v) { return isset($v[0]) && !isset($v[1]) ? $v[0] : $v; }, $value);
125 if ('request_server' !== $key && 'request_cookies' !== $key) {
126 $this->data[$key] = $value;
130 if (isset($this->controllers[$request])) {
131 $controller = $this->controllers[$request];
132 if (is_array($controller)) {
134 $r = new \ReflectionMethod($controller[0], $controller[1]);
135 $this->data['controller'] = array(
136 'class' => is_object($controller[0]) ? get_class($controller[0]) : $controller[0],
137 'method' => $controller[1],
138 'file' => $r->getFileName(),
139 'line' => $r->getStartLine(),
141 } catch (\ReflectionException $e) {
142 if (is_callable($controller)) {
143 // using __call or __callStatic
144 $this->data['controller'] = array(
145 'class' => is_object($controller[0]) ? get_class($controller[0]) : $controller[0],
146 'method' => $controller[1],
152 } elseif ($controller instanceof \Closure) {
153 $r = new \ReflectionFunction($controller);
154 $this->data['controller'] = array(
155 'class' => $r->getName(),
157 'file' => $r->getFileName(),
158 'line' => $r->getStartLine(),
160 } elseif (is_object($controller)) {
161 $r = new \ReflectionClass($controller);
162 $this->data['controller'] = array(
163 'class' => $r->getName(),
165 'file' => $r->getFileName(),
166 'line' => $r->getStartLine(),
169 $this->data['controller'] = (string) $controller ?: 'n/a';
171 unset($this->controllers[$request]);
175 public function getPathInfo()
177 return $this->data['path_info'];
180 public function getRequestRequest()
182 return new ParameterBag($this->data['request_request']);
185 public function getRequestQuery()
187 return new ParameterBag($this->data['request_query']);
190 public function getRequestHeaders()
192 return new ParameterBag($this->data['request_headers']);
195 public function getRequestServer()
197 return new ParameterBag($this->data['request_server']);
200 public function getRequestCookies()
202 return new ParameterBag($this->data['request_cookies']);
205 public function getRequestAttributes()
207 return new ParameterBag($this->data['request_attributes']);
210 public function getResponseHeaders()
212 return new ParameterBag($this->data['response_headers']);
215 public function getSessionMetadata()
217 return $this->data['session_metadata'];
220 public function getSessionAttributes()
222 return $this->data['session_attributes'];
225 public function getFlashes()
227 return $this->data['flashes'];
230 public function getContent()
232 return $this->data['content'];
235 public function getContentType()
237 return $this->data['content_type'];
240 public function getStatusText()
242 return $this->data['status_text'];
245 public function getStatusCode()
247 return $this->data['status_code'];
250 public function getFormat()
252 return $this->data['format'];
255 public function getLocale()
257 return $this->data['locale'];
261 * Gets the route name.
263 * The _route request attributes is automatically set by the Router Matcher.
265 * @return string The route
267 public function getRoute()
269 return isset($this->data['request_attributes']['_route']) ? $this->data['request_attributes']['_route'] : '';
273 * Gets the route parameters.
275 * The _route_params request attributes is automatically set by the RouterListener.
277 * @return array The parameters
279 public function getRouteParams()
281 return isset($this->data['request_attributes']['_route_params']) ? $this->data['request_attributes']['_route_params'] : array();
285 * Gets the controller.
287 * @return string The controller as a string
289 public function getController()
291 return $this->data['controller'];
294 public function onKernelController(FilterControllerEvent $event)
296 $this->controllers[$event->getRequest()] = $event->getController();
299 public static function getSubscribedEvents()
301 return array(KernelEvents::CONTROLLER => 'onKernelController');
307 public function getName()