Add the SentryExceptionListenerInterface

The SentryExceptionListenerInterface serves as a contract enforcing the
shape of the exception listener. The shape is important because, for
Sentry exception listeners, it is necessary to capture exceptions
coming from both web requests (GetResponseForExceptionEvents) and the
console (ConsoleExceptionEvents).

Author: swquinn

README.md

@@ -146,14 +146,15 @@ sentry:
 // src/AppBundle/EventSubscriber/MySentryEventListener.php
 namespace AppBundle\EventSubscriber;
 
+use Sentry\SentryBundle\EventListener\SentryExceptionListenerInterface;
 use Symfony\Component\Console\Event\ConsoleExceptionEvent;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
-class MySentryExceptionListener
+class MySentryExceptionListener implements SentryExceptionListenerInterface
 {
     // ...
 

src/Sentry/SentryBundle/EventListener/ExceptionListener.php

@@ -20,7 +20,7 @@
  * Class ExceptionListener
  * @package Sentry\SentryBundle\EventListener
  */
-class ExceptionListener
+class ExceptionListener implements SentryExceptionListenerInterface
 {
     /** @var  TokenStorageInterface */
     private $tokenStorage;

src/Sentry/SentryBundle/EventListener/SentryExceptionListenerInterface.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Sentry\SentryBundle\EventListener;
+
+use Symfony\Component\Console\Event\ConsoleExceptionEvent;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
+use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+
+interface SentryExceptionListenerInterface
+{
+
+    /**
+     * Used to capture information from the request before any possible error
+     * event is encountered by listening on core.request.
+     *
+     * Most commonly used for assigning the username to the security context
+     * used by Sentry for each request.
+     *
+     * @param GetResponseEvent $event
+     */
+    function onKernelRequest(GetResponseEvent $event);
+
+    /**
+     * When an exception occurs as part of a web request, this method will be
+     * triggered for capturing the error.
+     *
+     * @param GetResponseForExceptionEvent $event
+     */
+    function onKernelException(GetResponseForExceptionEvent $event);
+
+    /**
+     * When an exception occurs on the command line, this method will be
+     * triggered for capturing the error.
+     *
+     * @param ConsoleExceptionEvent $event
+     */
+    function onConsoleException(ConsoleExceptionEvent $event);
+
+}