bug #46 SuperClass AbstractClient can not have indentifier mapped (yoshz)

This PR was merged into the 0.1-dev branch.

Discussion
----------

SuperClass AbstractClient can not have indentifier mapped

This is a fix for bug #45.

Turns out that AbstractClient is wrongly mapped.
Quoted from [Doctrine/ORM documentation](master...yoshz:bugfix/docrine-mapping):

> A mapped superclass cannot be an entity, it is not query-able and persistent relationships defined by a mapped superclass must be unidirectional (with an owning side only). This means that One-To-Many associations are not possible on a mapped superclass at all. Furthermore Many-To-Many associations are only possible if the mapped superclass is only used in exactly one entity at the moment. For further support of inheritance, the single or joined table inheritance features have to be used.

So AbstractClient can not have an identifier and can not be used as an association between entities.

Commits
-------

b91268b SuperClass AbstractClient can not have indentifier mapped

Author: chalasr

docs/using-custom-client.md

@@ -14,14 +14,14 @@
     use Doctrine\ORM\Mapping as ORM;
     use League\Bundle\OAuth2ServerBundle\Model\AbstractClient;
 
-    /**
-     * @ORM\Entity
-     */
+    #[ORM\Entity]
     class Client extends AbstractClient
     {
-        /**
-         * @ORM\Column(type="string")
-         */
+        #[ORM\Id]
+        #[ORM\Column(type: 'string', length: 32)]
+        protected $identifier;
+
+        #[ORM\Column(type: 'string')]
         private $image;
 
         // other properties, getters, setters, ...

src/DependencyInjection/LeagueOAuth2ServerExtension.php

@@ -4,7 +4,6 @@
 
 namespace League\Bundle\OAuth2ServerBundle\DependencyInjection;
 
-use Defuse\Crypto\Key;
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use League\Bundle\OAuth2ServerBundle\AuthorizationServer\GrantTypeInterface;
 use League\Bundle\OAuth2ServerBundle\Command\CreateClientCommand;
@@ -16,7 +15,6 @@
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\ClientManager;
 use League\Bundle\OAuth2ServerBundle\Manager\Doctrine\RefreshTokenManager;
 use League\Bundle\OAuth2ServerBundle\Manager\ScopeManagerInterface;
-use League\Bundle\OAuth2ServerBundle\Model\Client;
 use League\Bundle\OAuth2ServerBundle\Model\Scope as ScopeModel;
 use League\Bundle\OAuth2ServerBundle\Persistence\Mapping\Driver;
 use League\Bundle\OAuth2ServerBundle\Security\Authenticator\OAuth2Authenticator;
@@ -268,7 +266,7 @@ private function configureDoctrinePersistence(ContainerBuilder $container, array
 
         $container
             ->findDefinition(Driver::class)
-            ->replaceArgument(0, Client::class !== $config['client']['classname'])
+            ->replaceArgument(0, $config['client']['classname'])
         ;
 
         $container->setParameter('league.oauth2_server.persistence.doctrine.enabled', true);

src/Model/AbstractClient.php

@@ -19,7 +19,7 @@ abstract class AbstractClient
     /**
      * @var string
      */
-    private $identifier;
+    protected $identifier;
 
     /**
      * @var string|null

src/Persistence/Mapping/Driver.php

@@ -21,13 +21,13 @@
 class Driver implements MappingDriver
 {
     /**
-     * @var bool
+     * @var string
      */
-    private $withCustomClientClass;
+    private $clientClass;
 
-    public function __construct(bool $withCustomClientClass)
+    public function __construct(string $clientClass)
     {
-        $this->withCustomClientClass = $withCustomClientClass;
+        $this->clientClass = $clientClass;
     }
 
     public function loadMetadataForClass($className, ClassMetadata $metadata): void
@@ -67,20 +67,19 @@ public function getAllClassNames(): array
                 AuthorizationCode::class,
                 RefreshToken::class,
             ],
-            $this->withCustomClientClass ? [] : [Client::class]
+            Client::class === $this->clientClass ? [Client::class] : []
         );
     }
 
     public function isTransient($className): bool
     {
-        return AbstractClient::class !== $className;
+        return false;
     }
 
     private function buildAbstractClientMetadata(ClassMetadata $metadata): void
     {
         (new ClassMetadataBuilder($metadata))
             ->setMappedSuperClass()
-            ->createField('identifier', 'string')->makePrimaryKey()->length(32)->build()
             ->createField('name', 'string')->length(128)->build()
             ->createField('secret', 'string')->length(128)->nullable(true)->build()
             ->createField('redirectUris', 'oauth2_redirect_uri')->nullable(true)->build()
@@ -100,7 +99,7 @@ private function buildAccessTokenMetadata(ClassMetadata $metadata): void
             ->createField('userIdentifier', 'string')->length(128)->nullable(true)->build()
             ->createField('scopes', 'oauth2_scope')->nullable(true)->build()
             ->addField('revoked', 'boolean')
-            ->createManyToOne('client', Client::class)->addJoinColumn('client', 'identifier', false, false, 'CASCADE')->build()
+            ->createManyToOne('client', $this->clientClass)->addJoinColumn('client', 'identifier', false, false, 'CASCADE')->build()
         ;
     }
 
@@ -113,13 +112,16 @@ private function buildAuthorizationCodeMetadata(ClassMetadata $metadata): void
             ->createField('userIdentifier', 'string')->length(128)->nullable(true)->build()
             ->createField('scopes', 'oauth2_scope')->nullable(true)->build()
             ->addField('revoked', 'boolean')
-            ->createManyToOne('client', Client::class)->addJoinColumn('client', 'identifier', false, false, 'CASCADE')->build()
+            ->createManyToOne('client', $this->clientClass)->addJoinColumn('client', 'identifier', false, false, 'CASCADE')->build()
         ;
     }
 
     private function buildClientMetadata(ClassMetadata $metadata): void
     {
-        (new ClassMetadataBuilder($metadata))->setTable('oauth2_client');
+        (new ClassMetadataBuilder($metadata))
+            ->setTable('oauth2_client')
+            ->createField('identifier', 'string')->makePrimaryKey()->length(32)->build()
+        ;
     }
 
     private function buildRefreshTokenMetadata(ClassMetadata $metadata): void