Add convenience method to get the identifier.

cakephp · Jul 26, 2024 · 2a2e337 · 2a2e337
1 parent 8308710
commit 2a2e337
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/src/Controller/Component/AuthenticationComponent.php b/src/Controller/Component/AuthenticationComponent.php
@@ -240,6 +240,16 @@ public function getResult(): ?ResultInterface
         return $this->getAuthenticationService()->getResult();
     }
 
+    /**
+     * Get the identifier (primary key) of the identity.
+     *
+     * @return array|string|int|null
+     */
+    public function getId(): array|string|int|null
+    {
+        return $this->getIdentity()?->getIdentifier();
+    }
+
     /**
      * Returns the identity used in the authentication attempt.
      *

diff --git a/tests/TestCase/Controller/Component/AuthenticationComponentTest.php b/tests/TestCase/Controller/Component/AuthenticationComponentTest.php
@@ -143,6 +143,22 @@ public function testGetAuthenticationServiceInvalidServiceObject()
         $component->getAuthenticationService();
     }
 
+    public function testGetId(): void
+    {
+        $component = new AuthenticationComponent(new ComponentRegistry(new Controller($this->request)));
+        $this->assertNull($component->getId());
+
+        $request = $this->request
+            ->withAttribute('identity', $this->identity)
+            ->withAttribute('authentication', $this->service);
+
+        $controller = new Controller($request);
+        $registry = new ComponentRegistry($controller);
+        $component = new AuthenticationComponent($registry);
+
+        $this->assertSame($component->getId(), $this->identity->getIdentifier());
+    }
+
     /**
      * testGetIdentity
      *