Support Doctrine ORM 3.0

Author: wmouwen

.github/workflows/static-analysis.yml

@@ -11,15 +11,24 @@ jobs:
     static-analysis:
         name: "static analysis"
         runs-on: "ubuntu-latest"
+        strategy:
+            fail-fast: false
+            matrix:
+                doctrine-orm: ['2.14.*', '2.18.*', '3.0.*']
+                composer-flags: ['--prefer-stable']
+
         steps:
             - name: "checkout"
               uses: "actions/checkout@v4"
 
             - name: "build the environment"
               run: "dev/bin/docker-compose build"
 
+            - name: "require specific Doctrine ORM version"
+              run: "dev/bin/php composer require --ansi ${{ matrix.composer-flags }} doctrine/orm:${{ matrix.doctrine-orm }}"
+
             - name: "install dependencies"
-              run: "dev/bin/php composer update --prefer-stable"
+              run: "dev/bin/php composer update --ansi ${{ matrix.composer-flags }}"
 
             - name: "run static analysis"
               run: "dev/bin/php psalm --shepherd --stats"

.github/workflows/unit-tests.yml

@@ -16,13 +16,18 @@ jobs:
             matrix:
                 php: ['8.1', '8.2', '8.3']
                 symfony: ['5.4.*', '6.4.*', '7.0.*']
+                doctrine-orm: ['2.14.*', '2.18.*', '3.0.*']
                 composer-flags: ['--prefer-stable']
                 can-fail: [false]
                 exclude:
                     - php: "8.1"
                       symfony: "7.0.*"
+                    - doctrine-orm: "2.14.*"
+                      symfony: "6.4.*"
+                    - doctrine-orm: "2.14.*"
+                      symfony: "7.0.*"
 
-        name: "PHP ${{ matrix.php }} - Symfony ${{ matrix.symfony }}${{ matrix.composer-flags != '' && format(' - Composer {0}', matrix.composer-flags) || '' }}"
+        name: "PHP ${{ matrix.php }} - Doctrine ${{ matrix.doctrine-orm }} - Symfony ${{ matrix.symfony }}${{ matrix.composer-flags != '' && format(' - Composer {0}', matrix.composer-flags) || '' }}"
 
         env:
             SYMFONY_REQUIRE: ${{ matrix.symfony }}
@@ -34,6 +39,9 @@ jobs:
             - name: "build the PHP environment"
               run: "dev/bin/docker-compose build --build-arg PHP_VERSION=${{ matrix.php }} --build-arg XDEBUG_VERSION='3.3.1' php"
 
+            - name: "require specific Doctrine ORM version"
+              run: "dev/bin/php composer require --ansi ${{ matrix.composer-flags }} doctrine/orm:${{ matrix.doctrine-orm }}"
+
             - name: "install dependencies"
               run: "dev/bin/php composer update --ansi ${{ matrix.composer-flags }}"
 

composer.json

@@ -18,7 +18,7 @@
     "require": {
         "php": "^8.1",
         "doctrine/doctrine-bundle": "^2.0.8",
-        "doctrine/orm": "^2.7.1",
+        "doctrine/orm": "^2.14|^3.0",
         "league/oauth2-server": "^8.3",
         "nyholm/psr7": "^1.4",
         "psr/http-factory": "^1.0",

src/Model/AbstractClient.php

@@ -15,45 +15,21 @@
  */
 abstract class AbstractClient implements ClientInterface
 {
-    /**
-     * @var string
-     */
-    private $name;
+    private string $name;
+    protected string $identifier;
+    private ?string $secret;
 
-    /**
-     * @var string
-     */
-    protected $identifier;
+    /** @var list<RedirectUri> */
+    private array $redirectUris = [];
 
-    /**
-     * @var string|null
-     */
-    private $secret;
+    /** @var list<Grant> */
+    private array $grants = [];
 
-    /**
-     * @var list<RedirectUri>
-     */
-    private $redirectUris = [];
+    /** @var list<Scope> */
+    private array $scopes = [];
 
-    /**
-     * @var list<Grant>
-     */
-    private $grants = [];
-
-    /**
-     * @var list<Scope>
-     */
-    private $scopes = [];
-
-    /**
-     * @var bool
-     */
-    private $active = true;
-
-    /**
-     * @var bool
-     */
-    private $allowPlainTextPkce = false;
+    private bool $active = true;
+    private bool $allowPlainTextPkce = false;
 
     /**
      * @psalm-mutation-free
@@ -165,7 +141,7 @@ public function setActive(bool $active): ClientInterface
      */
     public function isConfidential(): bool
     {
-        return !empty($this->secret);
+        return null !== $this->secret && '' !== $this->secret;
     }
 
     /**

src/Model/RefreshToken.php

@@ -6,30 +6,15 @@
 
 class RefreshToken implements RefreshTokenInterface
 {
-    /**
-     * @var string
-     */
-    private $identifier;
-
-    /**
-     * @var \DateTimeInterface
-     */
-    private $expiry;
-
-    /**
-     * @var AccessTokenInterface|null
-     */
-    private $accessToken;
-
-    /**
-     * @var bool
-     */
-    private $revoked = false;
+    private string $identifier;
+    private \DateTimeInterface $expiry;
+    private ?AccessTokenInterface $accessToken;
+    private bool $revoked = false;
 
     /**
      * @psalm-mutation-free
      */
-    public function __construct(string $identifier, \DateTimeInterface $expiry, AccessTokenInterface $accessToken = null)
+    public function __construct(string $identifier, \DateTimeInterface $expiry, ?AccessTokenInterface $accessToken = null)
     {
         $this->identifier = $identifier;
         $this->expiry = $expiry;

src/Security/Authenticator/OAuth2Authenticator.php

@@ -36,25 +36,10 @@ final class OAuth2Authenticator implements AuthenticatorInterface, Authenticatio
      */
     use ForwardCompatAuthenticatorTrait;
 
-    /**
-     * @var HttpMessageFactoryInterface
-     */
-    private $httpMessageFactory;
-
-    /**
-     * @var ResourceServer
-     */
-    private $resourceServer;
-
-    /**
-     * @var UserProviderInterface
-     */
-    private $userProvider;
-
-    /**
-     * @var string
-     */
-    private $rolePrefix;
+    private HttpMessageFactoryInterface $httpMessageFactory;
+    private ResourceServer $resourceServer;
+    private UserProviderInterface $userProvider;
+    private string $rolePrefix;
 
     public function __construct(
         HttpMessageFactoryInterface $httpMessageFactory,
@@ -73,7 +58,7 @@ public function supports(Request $request): ?bool
         return str_starts_with($request->headers->get('Authorization', ''), 'Bearer ');
     }
 
-    public function start(Request $request, AuthenticationException $authException = null): Response
+    public function start(Request $request, ?AuthenticationException $authException = null): Response
     {
         return new Response('', 401, ['WWW-Authenticate' => 'Bearer']);
     }

src/Security/Exception/InsufficientScopesException.php

@@ -9,7 +9,7 @@
  */
 class InsufficientScopesException extends OAuth2AuthenticationException
 {
-    public static function create(\Throwable $previous = null): self
+    public static function create(?\Throwable $previous = null): self
     {
         return new self('Insufficient scopes.', 403, $previous);
     }

src/Security/Exception/OAuth2AuthenticationException.php

@@ -12,12 +12,9 @@
  */
 class OAuth2AuthenticationException extends AuthenticationException implements HttpExceptionInterface
 {
-    /**
-     * @var int
-     */
-    private $statusCode;
+    private int $statusCode;
 
-    public function __construct(string $message, int $statusCode, \Throwable $previous = null)
+    public function __construct(string $message, int $statusCode, ?\Throwable $previous = null)
     {
         $this->statusCode = $statusCode;
 

src/Security/Exception/OAuth2AuthenticationFailedException.php

@@ -9,7 +9,7 @@
  */
 class OAuth2AuthenticationFailedException extends OAuth2AuthenticationException
 {
-    public static function create(string $message, \Throwable $previous = null): self
+    public static function create(string $message, ?\Throwable $previous = null): self
     {
         return new self($message, 401, $previous);
     }

tests/Acceptance/DoctrineCredentialsRevokerTest.php

@@ -90,7 +90,7 @@ private function buildRefreshToken(string $identifier, string $modify, AccessTok
         );
     }
 
-    private function buildAccessToken(string $identifier, string $modify, Client $client, string $userIdentifier = null): AccessToken
+    private function buildAccessToken(string $identifier, string $modify, Client $client, ?string $userIdentifier = null): AccessToken
     {
         return new AccessToken(
             $identifier,
@@ -101,7 +101,7 @@ private function buildAccessToken(string $identifier, string $modify, Client $cl
         );
     }
 
-    private function buildAuthCode(string $identifier, string $modify, Client $client, string $userIdentifier = null): AuthorizationCode
+    private function buildAuthCode(string $identifier, string $modify, Client $client, ?string $userIdentifier = null): AuthorizationCode
     {
         return new AuthorizationCode(
             $identifier,