Merge pull request #204 from alister/phpstan-fixes

Phpstan fixes
knpuniversity · Oct 14, 2019 · 1ecb9f9 · 1ecb9f9
2 parents 0a132ab + aa68208
commit 1ecb9f9
Show file tree

Hide file tree

Showing 56 changed files with 186 additions and 115 deletions.
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,5 +1,5 @@
 parameters:
-	level: 1
+	level: max
 	inferPrivatePropertyTypeFromConstructor: true
 	paths:
 		- ./src/
@@ -17,3 +17,15 @@ parameters:
 		-
 			message: '#Class [a-zA-Z0-9\\_]+ not found#'
 			path: ./src/DependencyInjection/Providers
+
+		# The DependencyInjection returns are very complex to deal with
+		-
+			message: '#.*NodeParentInterface|null.*#'
+			path: ./src/DependencyInjection/Providers
+		-
+			message: '#.*NodeDefinition::children.*#'
+			path: ./src/DependencyInjection
+		# Searches for root(), for backward compatibility with Symfony <4.2. Removed in 5.0
+		-
+			message: '#Call to an undefined method Symfony\\Component\\Config\\Definition\\Builder\\TreeBuilder::root\(\)\.#'
+			path: ./src/DependencyInjection
diff --git a/src/Client/ClientRegistry.php b/src/Client/ClientRegistry.php
@@ -41,15 +41,23 @@ public function __construct(ContainerInterface $container, array $serviceMap)
      */
     public function getClient($key)
     {
-        if (!isset($this->serviceMap[$key])) {
-            throw new \InvalidArgumentException(sprintf(
-                'There is no OAuth2 client called "%s". Available are: %s',
-                $key,
-                implode(', ', array_keys($this->serviceMap))
-            ));
+        if (isset($this->serviceMap[$key])) {
+            $client = $this->container->get($this->serviceMap[$key]);
+            if (!$client instanceof OAuth2Client) {
+                throw new \InvalidArgumentException(sprintf(
+                    'Somehow the "%s" client is not an instance of OAuth2Client.',
+                    $key
+                ));
+            }
+
+            return $client;
         }
 
-        return $this->container->get($this->serviceMap[$key]);
+        throw new \InvalidArgumentException(sprintf(
+            'There is no OAuth2 client called "%s". Available are: %s',
+            $key,
+            implode(', ', array_keys($this->serviceMap))
+        ));
     }
 
     /**

diff --git a/src/Client/OAuth2Client.php b/src/Client/OAuth2Client.php
@@ -17,6 +17,7 @@
 use League\OAuth2\Client\Token\AccessToken;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\RequestStack;
+use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
 class OAuth2Client implements OAuth2ClientInterface
 {
@@ -82,7 +83,7 @@ public function redirect(array $scopes = [], array $options = [])
     /**
      * Call this after the user is redirected back to get the access token.
      *
-     * @return \League\OAuth2\Client\Token\AccessToken
+     * @return AccessToken|\League\OAuth2\Client\Token\AccessTokenInterface
      *
      * @throws InvalidStateException
      * @throws MissingAuthorizationCodeException
@@ -131,6 +132,7 @@ public function fetchUserFromToken(AccessToken $accessToken)
      */
     public function fetchUser()
     {
+        /** @var AccessToken $token */
         $token = $this->getAccessToken();
 
         return $this->fetchUserFromToken($token);
@@ -161,16 +163,14 @@ private function getCurrentRequest()
     }
 
     /**
-     * @return \Symfony\Component\HttpFoundation\Session\SessionInterface|null
+     * @return SessionInterface
      */
     private function getSession()
     {
-        $session = $this->getCurrentRequest()->getSession();
-
-        if (!$session) {
+        if (!$this->getCurrentRequest()->hasSession()) {
             throw new \LogicException('In order to use "state", you must have a session. Set the OAuth2Client to stateless to avoid state');
         }
 
-        return $session;
+        return $this->getCurrentRequest()->getSession();
     }
 }
diff --git a/src/Client/Provider/AmazonClient.php b/src/Client/Provider/AmazonClient.php
@@ -19,15 +19,15 @@ class AmazonClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return AmazonResourceOwner
+     * @return AmazonResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return AmazonResourceOwner
+     * @return AmazonResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/Auth0Client.php b/src/Client/Provider/Auth0Client.php
@@ -19,15 +19,15 @@ class Auth0Client extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return Auth0ResourceOwner
+     * @return Auth0ResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return Auth0ResourceOwner
+     * @return Auth0ResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/AzureClient.php b/src/Client/Provider/AzureClient.php
@@ -19,15 +19,15 @@ class AzureClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return AzureResourceOwner
+     * @return AzureResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return AzureResourceOwner
+     * @return AzureResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/BitbucketClient.php b/src/Client/Provider/BitbucketClient.php
@@ -19,15 +19,15 @@ class BitbucketClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return BitbucketResourceOwner
+     * @return BitbucketResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return BitbucketResourceOwner
+     * @return BitbucketResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/BoxClient.php b/src/Client/Provider/BoxClient.php
@@ -19,15 +19,15 @@ class BoxClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return BoxResourceOwner
+     * @return BoxResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return BoxResourceOwner
+     * @return BoxResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/BufferClient.php b/src/Client/Provider/BufferClient.php
@@ -19,15 +19,15 @@ class BufferClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return BufferUser
+     * @return BufferUser|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return BufferUser
+     * @return BufferUser|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/CanvasLMSClient.php b/src/Client/Provider/CanvasLMSClient.php
@@ -19,15 +19,15 @@ class CanvasLMSClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return CanvasLMSResourceOwner
+     * @return CanvasLMSResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return CanvasLMSResourceOwner
+     * @return CanvasLMSResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/CleverClient.php b/src/Client/Provider/CleverClient.php
@@ -19,15 +19,15 @@ class CleverClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return CleverUser
+     * @return CleverUser|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return CleverUser
+     * @return CleverUser|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DevianArtClient.php b/src/Client/Provider/DevianArtClient.php
@@ -19,15 +19,15 @@ class DevianArtClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DeviantArtResourceOwner
+     * @return DeviantArtResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DeviantArtResourceOwner
+     * @return DeviantArtResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DigitalOceanClient.php b/src/Client/Provider/DigitalOceanClient.php
@@ -19,15 +19,15 @@ class DigitalOceanClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DigitalOceanResourceOwner
+     * @return DigitalOceanResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DigitalOceanResourceOwner
+     * @return DigitalOceanResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DiscordClient.php b/src/Client/Provider/DiscordClient.php
@@ -19,15 +19,15 @@ class DiscordClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DiscordResourceOwner
+     * @return DiscordResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DiscordResourceOwner
+     * @return DiscordResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DribbbleClient.php b/src/Client/Provider/DribbbleClient.php
@@ -19,15 +19,15 @@ class DribbbleClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DribbbleResourceOwner
+     * @return DribbbleResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DribbbleResourceOwner
+     * @return DribbbleResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DropboxClient.php b/src/Client/Provider/DropboxClient.php
@@ -19,15 +19,15 @@ class DropboxClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DropboxResourceOwner
+     * @return DropboxResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DropboxResourceOwner
+     * @return DropboxResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/DrupalClient.php b/src/Client/Provider/DrupalClient.php
@@ -19,15 +19,15 @@ class DrupalClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return DrupalResourceOwner
+     * @return DrupalResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return DrupalResourceOwner
+     * @return DrupalResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/ElanceClient.php b/src/Client/Provider/ElanceClient.php
@@ -19,15 +19,15 @@ class ElanceClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return ElanceResourceOwner
+     * @return ElanceResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return ElanceResourceOwner
+     * @return ElanceResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {

diff --git a/src/Client/Provider/EveOnlineClient.php b/src/Client/Provider/EveOnlineClient.php
@@ -19,15 +19,15 @@ class EveOnlineClient extends OAuth2Client
     /**
      * @param AccessToken $accessToken
      *
-     * @return EveOnlineResourceOwner
+     * @return EveOnlineResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUserFromToken(AccessToken $accessToken)
     {
         return parent::fetchUserFromToken($accessToken);
     }
 
     /**
-     * @return EveOnlineResourceOwner
+     * @return EveOnlineResourceOwner|\League\OAuth2\Client\Provider\ResourceOwnerInterface
      */
     public function fetchUser()
     {