Depreciate injection of Request instances

Add missing notice-type
lexik · Jul 18, 2016 · ec56787 · ec56787
1 parent e84d3ef
commit ec56787
Show file tree

Hide file tree

Showing 8 changed files with 86 additions and 23 deletions.
diff --git a/Event/AuthenticationFailureEvent.php b/Event/AuthenticationFailureEvent.php
@@ -5,6 +5,7 @@
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 
 /**
@@ -17,6 +18,8 @@ class AuthenticationFailureEvent extends Event
 {
     /**
      * @var Request
+     *
+     * @deprecated since 1.7, removed in 2.0
      */
     protected $request;
 
@@ -31,22 +34,31 @@ class AuthenticationFailureEvent extends Event
     protected $response;
 
     /**
-     * @param Request                 $request
+     * @param Request|null            $request   Deprecated
      * @param AuthenticationException $exception
      * @param Response                $response
      */
-    public function __construct(Request $request, AuthenticationException $exception, Response $response)
+    public function __construct(Request $request = null, AuthenticationException $exception, Response $response)
     {
-        $this->request   = $request;
+        if (null !== $request && class_exists(RequestStack::class)) {
+            @trigger_error(sprintf('Passing a %s instance as first argument of %s() is deprecated since version 1.7 and will be removed in 2.0.\nInject the "@request_stack" service in your event listener instead.', Request::class, __METHOD__, PHP_EOL, RequestStack::class), E_USER_DEPRECATED);
+
+            $this->request = $request;
+        }
+
         $this->exception = $exception;
         $this->response  = $response;
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest()
     {
+        @trigger_error(sprintf('Method %s() is deprecated since version 1.7 and will be removed in 2.0.%sInject the "@request_stack" service in your event listener instead, then retrieve the current Request using %s::getCurrentRequest().', __METHOD__, PHP_EOL, RequestStack::class));
+
         return $this->request;
     }
 

diff --git a/Event/AuthenticationSuccessEvent.php b/Event/AuthenticationSuccessEvent.php
@@ -6,6 +6,7 @@
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
@@ -27,6 +28,8 @@ class AuthenticationSuccessEvent extends Event
 
     /**
      * @var Request
+     *
+     * @deprecated since 1.7, removed in 2.0
      */
     protected $request;
 
@@ -38,11 +41,17 @@ class AuthenticationSuccessEvent extends Event
     /**
      * @param array         $data
      * @param UserInterface $user
-     * @param Request       $request
+     * @param Request|null  $request Deprecated
      * @param Response      $response
      */
-    public function __construct(array $data, UserInterface $user, Request $request, Response $response)
+    public function __construct(array $data, UserInterface $user, Request $request = null, Response $response)
     {
+        if (null !== $request && class_exists(RequestStack::class)) {
+            @trigger_error(sprintf('Passing a %s instance as first argument of %s() is deprecated since version 1.7 and will be removed in 2.0.\nInject the "@request_stack" service in your event listener instead.', Request::class, __METHOD__, PHP_EOL, RequestStack::class), E_USER_DEPRECATED);
+
+            $this->request = $request;
+        }
+
         $this->data = $data;
         $this->user = $user;
         $this->request = $request;
@@ -74,10 +83,14 @@ public function getUser()
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest()
     {
+        @trigger_error(sprintf('Method %s() is deprecated since version 1.7 and will be removed in 2.0.%sInject the "@request_stack" service in your event listener instead, then retrieve the current Request using %s::getCurrentRequest().', __METHOD__, PHP_EOL, RequestStack::class));
+
         return $this->request;
     }
 

diff --git a/Event/JWTAuthenticatedEvent.php b/Event/JWTAuthenticatedEvent.php
@@ -21,12 +21,7 @@ class JWTAuthenticatedEvent extends Event
      * @var TokenInterface
      */
     protected $token;
-
-    /**
-     * @var Request
-     */
-    protected $request;
-
+
     /**
      * @param array          $payload
      * @param TokenInterface $token

diff --git a/Event/JWTCreatedEvent.php b/Event/JWTCreatedEvent.php
@@ -5,6 +5,7 @@
 
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
@@ -24,19 +25,26 @@ class JWTCreatedEvent extends Event
 
     /**
      * @var Request
+     *
+     * @deprecated since 1.7, removed in 2.0
      */
     protected $request;
 
     /**
      * @param array         $data
      * @param UserInterface $user
-     * @param Request       $request
+     * @param Request|null  $request Deprecated
      */
     public function __construct(array $data, UserInterface $user, Request $request = null)
     {
-        $this->data    = $data;
-        $this->user    = $user;
-        $this->request = $request;
+        if (null !== $request && class_exists(RequestStack::class)) {
+            @trigger_error(sprintf('Passing a %s instance as first argument of %s() is deprecated since version 1.7 and will be removed in 2.0.\nInject the "@request_stack" service in your event listener instead.', Request::class, __METHOD__, PHP_EOL, RequestStack::class), E_USER_DEPRECATED);
+
+            $this->request = $request;
+        }
+
+        $this->data = $data;
+        $this->user = $user;
     }
 
     /**
@@ -64,10 +72,14 @@ public function getUser()
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest()
     {
+        @trigger_error(sprintf('Method %s() is deprecated since version 1.7 and will be removed in 2.0.%sInject the "@request_stack" service in your event listener instead, then retrieve the current Request using %s::getCurrentRequest().', __METHOD__, PHP_EOL, RequestStack::class));
+
         return $this->request;
     }
 }
diff --git a/Event/JWTDecodedEvent.php b/Event/JWTDecodedEvent.php
@@ -4,6 +4,7 @@
 
 use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
  * JWTDecodedEvent
@@ -19,6 +20,8 @@ class JWTDecodedEvent extends Event
 
     /**
      * @var Request
+     *
+     * @deprecated since 1.7, removed in 2.0
      */
     protected $request;
 
@@ -28,13 +31,18 @@ class JWTDecodedEvent extends Event
     protected $isValid;
 
     /**
-     * @param array   $payload
-     * @param Request $request
+     * @param array        $payload
+     * @param Request|null $request Deprecated
      */
     public function __construct(array $payload, Request $request = null)
     {
+        if (null !== $request && class_exists(RequestStack::class)) {
+            @trigger_error(sprintf('Passing a %s instance as first argument of %s() is deprecated since version 1.7 and will be removed in 2.0.\nInject the "@request_stack" service in your event listener instead.', Request::class, __METHOD__, PHP_EOL, RequestStack::class), E_USER_DEPRECATED);
+
+            $this->request = $request;
+        }
+
         $this->payload = $payload;
-        $this->request = $request;
         $this->isValid = true;
     }
 
@@ -47,10 +55,14 @@ public function getPayload()
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest()
     {
+        @trigger_error(sprintf('Method %s() is deprecated since version 1.7 and will be removed in 2.0.%sInject the "@request_stack" service in your event listener instead, then retrieve the current Request using %s::getCurrentRequest().', __METHOD__, PHP_EOL, RequestStack::class));
+
         return $this->request;
     }
 

diff --git a/Event/JWTFailureEventInterface.php b/Event/JWTFailureEventInterface.php
@@ -8,7 +8,7 @@
 
 /**
  * Interface for event classes that are dispatched when a JWT cannot be authenticated.
- * 
+ *
  * @author Robin Chalas <[email protected]>
  */
 interface JWTFailureEventInterface
@@ -19,6 +19,8 @@ interface JWTFailureEventInterface
     public function getResponse();
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest();

diff --git a/Event/JWTNotFoundEvent.php b/Event/JWTNotFoundEvent.php
@@ -4,24 +4,30 @@
 
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 
 /**
- * JWTNotFoundEvent event is dispatched when a JWT cannot be found in a request 
+ * JWTNotFoundEvent event is dispatched when a JWT cannot be found in a request
  * covered by a firewall secured via lexik_jwt.
  *
  * @author Robin Chalas <[email protected]>
  */
 class JWTNotFoundEvent extends AuthenticationFailureEvent implements JWTFailureEventInterface
 {
     /**
-     * @param Request                      $request
+     * @param Request|null                 $request   Deprecated
      * @param AuthenticationException|null $exception
      * @param Response|null                $response
      */
-    public function __construct(Request $request, AuthenticationException $exception = null, Response $response = null)
+    public function __construct(Request $request = null, AuthenticationException $exception = null, Response $response = null)
     {
-        $this->request   = $request;
+        if (null !== $request && class_exists(RequestStack::class)) {
+            @trigger_error(sprintf('Passing a %s instance as first argument of %s() is deprecated since version 1.7 and will be removed in 2.0.\nInject the "@request_stack" service in your event listener instead.', Request::class, __METHOD__, PHP_EOL, RequestStack::class), E_USER_DEPRECATED);
+
+            $this->request = $request;
+        }
+
         $this->exception = $exception;
         $this->response  = $response;
     }

diff --git a/Services/JWTManager.php b/Services/JWTManager.php
@@ -43,12 +43,15 @@ class JWTManager implements JWTManagerInterface
 
     /**
      * @var Request
+     *
+     * @deprecated since 1.7, removed in 2.0
      */
     protected $request;
 
     /**
      * @param JWTEncoderInterface      $encoder
      * @param EventDispatcherInterface $dispatcher
+     * @param RequestStack             $requestStack
      * @param int                      $ttl
      */
     public function __construct(JWTEncoderInterface $encoder, EventDispatcherInterface $dispatcher, $ttl)
@@ -132,10 +135,14 @@ public function setUserIdentityField($userIdentityField)
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @param RequestStack|Request $requestStack
      */
     public function setRequest($requestStack)
     {
+        @trigger_error(sprintf('Method %s::%s() is deprecated since version 1.7 and will be removed in 2.0.', __METHOD__), E_USER_DEPRECATED);
+
         if ($requestStack instanceof Request) {
             $this->request = $requestStack;
         } elseif ($requestStack instanceof RequestStack) {
@@ -144,10 +151,14 @@ public function setRequest($requestStack)
     }
 
     /**
+     * @deprecated since 1.7, removed in 2.0
+     *
      * @return Request
      */
     public function getRequest()
     {
+        @trigger_error(sprintf('Method %s::%s() is deprecated since version 1.7 and will be removed in 2.0.', __METHOD__), E_USER_DEPRECATED);
+
         return $this->request;
     }
 }