[Summary view] [Print] [Text view]

   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;
  13  
  14  /**
  15   * Contains all events thrown in the HttpKernel component.
  16   *
  17   * @author Bernhard Schussek <bschussek@gmail.com>
  18   */
  19  final class KernelEvents
  20  {
  21      /**
  22       * The REQUEST event occurs at the very beginning of request
  23       * dispatching.
  24       *
  25       * This event allows you to create a response for a request before any
  26       * other code in the framework is executed.
  27       *
  28       * @Event("Symfony\Component\HttpKernel\Event\GetResponseEvent")
  29       */
  30      const REQUEST = 'kernel.request';
  31  
  32      /**
  33       * The EXCEPTION event occurs when an uncaught exception appears.
  34       *
  35       * This event allows you to create a response for a thrown exception or
  36       * to modify the thrown exception.
  37       *
  38       * @Event("Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent")
  39       */
  40      const EXCEPTION = 'kernel.exception';
  41  
  42      /**
  43       * The VIEW event occurs when the return value of a controller
  44       * is not a Response instance.
  45       *
  46       * This event allows you to create a response for the return value of the
  47       * controller.
  48       *
  49       * @Event("Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent")
  50       */
  51      const VIEW = 'kernel.view';
  52  
  53      /**
  54       * The CONTROLLER event occurs once a controller was found for
  55       * handling a request.
  56       *
  57       * This event allows you to change the controller that will handle the
  58       * request.
  59       *
  60       * @Event("Symfony\Component\HttpKernel\Event\FilterControllerEvent")
  61       */
  62      const CONTROLLER = 'kernel.controller';
  63  
  64      /**
  65       * The CONTROLLER_ARGUMENTS event occurs once controller arguments have been resolved.
  66       *
  67       * This event allows you to change the arguments that will be passed to
  68       * the controller.
  69       *
  70       * @Event("Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent")
  71       */
  72      const CONTROLLER_ARGUMENTS = 'kernel.controller_arguments';
  73  
  74      /**
  75       * The RESPONSE event occurs once a response was created for
  76       * replying to a request.
  77       *
  78       * This event allows you to modify or replace the response that will be
  79       * replied.
  80       *
  81       * @Event("Symfony\Component\HttpKernel\Event\FilterResponseEvent")
  82       */
  83      const RESPONSE = 'kernel.response';
  84  
  85      /**
  86       * The TERMINATE event occurs once a response was sent.
  87       *
  88       * This event allows you to run expensive post-response jobs.
  89       *
  90       * @Event("Symfony\Component\HttpKernel\Event\PostResponseEvent")
  91       */
  92      const TERMINATE = 'kernel.terminate';
  93  
  94      /**
  95       * The FINISH_REQUEST event occurs when a response was generated for a request.
  96       *
  97       * This event allows you to reset the global and environmental state of
  98       * the application, when it was changed during the request.
  99       *
 100       * @Event("Symfony\Component\HttpKernel\Event\FinishRequestEvent")
 101       */
 102      const FINISH_REQUEST = 'kernel.finish_request';
 103  }