www.aleph1.co.uk Git - yaffs-website/blob - vendor/symfony/http-kernel/KernelEvents.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;
  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      * @var string
  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.
  39      *
  40      * @Event("Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent")
  41      *
  42      * @var string
  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.
  52      *
  53      * @Event("Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent")
  54      *
  55      * @var string
  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.
  65      *
  66      * @Event("Symfony\Component\HttpKernel\Event\FilterControllerEvent")
  67      *
  68      * @var string
  69      */
  70     const CONTROLLER = 'kernel.controller';
  71
  72     /**
  73      * The CONTROLLER_ARGUMENTS event occurs once controller arguments have been resolved.
  74      *
  75      * This event allows you to change the arguments that will be passed to
  76      * the controller.
  77      *
  78      * @Event("Symfony\Component\HttpKernel\Event\FilterControllerArgumentsEvent")
  79      *
  80      * @var string
  81      */
  82     const CONTROLLER_ARGUMENTS = 'kernel.controller_arguments';
  83
  84     /**
  85      * The RESPONSE event occurs once a response was created for
  86      * replying to a request.
  87      *
  88      * This event allows you to modify or replace the response that will be
  89      * replied.
  90      *
  91      * @Event("Symfony\Component\HttpKernel\Event\FilterResponseEvent")
  92      *
  93      * @var string
  94      */
  95     const RESPONSE = 'kernel.response';
  96
  97     /**
  98      * The TERMINATE event occurs once a response was sent.
  99      *
 100      * This event allows you to run expensive post-response jobs.
 101      *
 102      * @Event("Symfony\Component\HttpKernel\Event\PostResponseEvent")
 103      *
 104      * @var string
 105      */
 106     const TERMINATE = 'kernel.terminate';
 107
 108     /**
 109      * The FINISH_REQUEST event occurs when a response was generated for a request.
 110      *
 111      * This event allows you to reset the global and environmental state of
 112      * the application, when it was changed during the request.
 113      *
 114      * @Event("Symfony\Component\HttpKernel\Event\FinishRequestEvent")
 115      *
 116      * @var string
 117      */
 118     const FINISH_REQUEST = 'kernel.finish_request';
 119 }