[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. The event listener method
  27       * receives a Symfony\Component\HttpKernel\Event\GetResponseEvent
  28       * instance.
  29       *
  30       * @Event
  31       */
  32      const REQUEST = 'kernel.request';
  33  
  34      /**
  35       * The EXCEPTION event occurs when an uncaught exception appears.
  36       *
  37       * This event allows you to create a response for a thrown exception or
  38       * to modify the thrown exception. The event listener method receives
  39       * a Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent
  40       * instance.
  41       *
  42       * @Event
  43       */
  44      const EXCEPTION = 'kernel.exception';
  45  
  46      /**
  47       * The VIEW event occurs when the return value of a controller
  48       * is not a Response instance.
  49       *
  50       * This event allows you to create a response for the return value of the
  51       * controller. The event listener method receives a
  52       * Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent
  53       * instance.
  54       *
  55       * @Event
  56       */
  57      const VIEW = 'kernel.view';
  58  
  59      /**
  60       * The CONTROLLER event occurs once a controller was found for
  61       * handling a request.
  62       *
  63       * This event allows you to change the controller that will handle the
  64       * request. The event listener method receives a
  65       * Symfony\Component\HttpKernel\Event\FilterControllerEvent instance.
  66       *
  67       * @Event
  68       */
  69      const CONTROLLER = 'kernel.controller';
  70  
  71      /**
  72       * The RESPONSE event occurs once a response was created for
  73       * replying to a request.
  74       *
  75       * This event allows you to modify or replace the response that will be
  76       * replied. The event listener method receives a
  77       * Symfony\Component\HttpKernel\Event\FilterResponseEvent instance.
  78       *
  79       * @Event
  80       */
  81      const RESPONSE = 'kernel.response';
  82  
  83      /**
  84       * The TERMINATE event occurs once a response was sent.
  85       *
  86       * This event allows you to run expensive post-response jobs.
  87       * The event listener method receives a
  88       * Symfony\Component\HttpKernel\Event\PostResponseEvent instance.
  89       *
  90       * @Event
  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       * The event listener method receives a
 100       * Symfony\Component\HttpKernel\Event\FinishRequestEvent instance.
 101       *
 102       * @Event
 103       */
 104      const FINISH_REQUEST = 'kernel.finish_request';
 105  }