aleph1.co.uk Git - yaffs-website/blob - http-kernel/DataCollector/DataCollectorInterface.php

   1 <?php
   2
   3 /*
   4  * This file is part of the Symfony package.
   5  *
   6  * (c) Fabien Potencier <fabien@symfony.com>
   7  *
   8  * For the full copyright and license information, please view the LICENSE
   9  * file that was distributed with this source code.
  10  */
  11
  12 namespace Symfony\Component\HttpKernel\DataCollector;
  13
  14 use Symfony\Component\HttpFoundation\Request;
  15 use Symfony\Component\HttpFoundation\Response;
  16
  17 /**
  18  * DataCollectorInterface.
  19  *
  20  * @author Fabien Potencier <fabien@symfony.com>
  21  *
  22  * @method reset() Resets this data collector to its initial state.
  23  */
  24 interface DataCollectorInterface
  25 {
  26     /**
  27      * Collects data for the given Request and Response.
  28      */
  29     public function collect(Request $request, Response $response, \Exception $exception = null);
  30
  31     /**
  32      * Returns the name of the collector.
  33      *
  34      * @return string The collector name
  35      */
  36     public function getName();
  37 }