Fix namespace in PHPDoc, phpstan errors and CI stan command

Nikola · Nikola · commit 600d26dae041 · 2026-02-22T18:05:42.000+01:00
- Fix all PHPDoc @param/@return types from \Verification\ to \Salines\Verification\ - Simplify getOriginalData() handling to match ArrayAccess|array return type - Add --memory-limit=512M to phpstan script in composer.json
diff --git a/composer.json b/composer.json
@@ -30,7 +30,8 @@
     "scripts": {
         "test": "phpunit",
         "cs": "phpcs -p",
-        "cbf": "phpcbf"
+        "cbf": "phpcbf",
+        "stan": "phpstan analyse --memory-limit=512M"
     },
     "support": {
         "issues": "https://github.com/salines/cakephp-verification/issues",
diff --git a/src/Controller/Component/VerificationComponent.php b/src/Controller/Component/VerificationComponent.php
@@ -119,7 +119,7 @@ public function startup(EventInterface $event): ?Response
     }
 
     /**
-     * @param \Verification\Service\VerificationServiceInterface $service Service instance
+     * @param \Salines\Verification\Service\VerificationServiceInterface $service Service instance
      * @return void
      */
     public function setService(VerificationServiceInterface $service): void
@@ -128,7 +128,7 @@ public function setService(VerificationServiceInterface $service): void
     }
 
     /**
-     * @return \Verification\Service\VerificationServiceInterface
+     * @return \Salines\Verification\Service\VerificationServiceInterface
      */
     public function getService(): VerificationServiceInterface
     {
@@ -150,7 +150,7 @@ public function getService(): VerificationServiceInterface
 
     /**
      * @param string $name Driver name
-     * @return \Verification\Verificator\VerificationVerificatorInterface|null
+     * @return \Salines\Verification\Verificator\VerificationVerificatorInterface|null
      */
     public function getDriver(string $name): ?VerificationVerificatorInterface
     {
@@ -207,7 +207,7 @@ public function verify(
 
     /**
      * @param \Psr\Http\Message\ServerRequestInterface|null $request Request
-     * @return \Verification\Value\VerificationResult
+     * @return \Salines\Verification\Value\VerificationResult
      */
     public function result(?ServerRequestInterface $request = null): VerificationResult
     {
@@ -220,7 +220,7 @@ public function result(?ServerRequestInterface $request = null): VerificationRes
      * Select verification step.
      *
      * @param string|null $step Step name
-     * @param \Verification\Value\VerificationResult $verification Result
+     * @param \Salines\Verification\Value\VerificationResult $verification Result
      * @return string
      */
     public function selectStep(?string $step, VerificationResult $verification): string
@@ -500,8 +500,8 @@ public function startLoginFlow(?IdentityInterface $identity = null): void
      * Apply default OTP delivery callback.
      *
      * @param string $step Step name
-     * @param \Verification\Verificator\VerificationVerificatorInterface $driver Driver
-     * @return \Verification\Verificator\VerificationVerificatorInterface
+     * @param \Salines\Verification\Verificator\VerificationVerificatorInterface $driver Driver
+     * @return \Salines\Verification\Verificator\VerificationVerificatorInterface
      */
     private function applyDefaultOtpDelivery(
         string $step,
@@ -539,8 +539,8 @@ private function applyDefaultOtpDelivery(
     /**
      * Apply default email-verify delivery callback.
      *
-     * @param \Verification\Verificator\VerificationVerificatorInterface $driver Driver
-     * @return \Verification\Verificator\VerificationVerificatorInterface
+     * @param \Salines\Verification\Verificator\VerificationVerificatorInterface $driver Driver
+     * @return \Salines\Verification\Verificator\VerificationVerificatorInterface
      */
     private function applyDefaultEmailVerifyDelivery(
         VerificationVerificatorInterface $driver,
@@ -909,13 +909,7 @@ public function handleChooseVerification(): ?Response
         }
 
         $origData = $identity->getOriginalData();
-        if (is_object($origData)) {
-            $prefs = $origData->{$prefsField} ?? null;
-        } elseif (is_array($origData)) {
-            $prefs = $origData[$prefsField] ?? null;
-        } else {
-            $prefs = null;
-        }
+        $prefs = $origData[$prefsField] ?? null;
         if (is_string($prefs)) {
             $prefs = json_decode($prefs, true);
         }
@@ -1129,7 +1123,7 @@ private function decryptSecret(string $payload): string
     /**
      * Get crypto driver.
      *
-     * @return \Verification\Security\CryptoInterface|null
+     * @return \Salines\Verification\Security\CryptoInterface|null
      */
     private function getCrypto(): ?CryptoInterface
     {
diff --git a/src/Security/CryptoFactory.php b/src/Security/CryptoFactory.php
@@ -24,7 +24,7 @@ final class CryptoFactory
      * Create a crypto driver from the Verification.crypto config array.
      *
      * @param array<string, mixed> $config
-     * @return \Verification\Security\CryptoInterface|null  null when crypto is not configured
+     * @return \Salines\Verification\Security\CryptoInterface|null  null when crypto is not configured
      */
     public static function create(array $config): ?CryptoInterface
     {
diff --git a/src/Service/VerificationService.php b/src/Service/VerificationService.php
@@ -401,7 +401,7 @@ private function isStepEnabled(string $step): bool
 
     /**
      * @param mixed $class
-     * @return class-string<\Verification\Verificator\VerificationVerificatorInterface>|null
+     * @return class-string<\Salines\Verification\Verificator\VerificationVerificatorInterface>|null
      */
     private function normalizeDriverClass(mixed $class): ?string
     {
@@ -446,7 +446,7 @@ private function extractIdentityData(IdentityInterface $identity): array
     }
 
     /**
-     * @param class-string<\Verification\Verificator\VerificationVerificatorInterface> $class
+     * @param class-string<\Salines\Verification\Verificator\VerificationVerificatorInterface> $class
      * @param array<string, mixed> $config
      */
     private function instantiateDriver(string $class, array $config): VerificationVerificatorInterface
@@ -461,7 +461,7 @@ private function instantiateDriver(string $class, array $config): VerificationVe
     }
 
     /**
-     * @return \Verification\Transport\Sms\TransportInterface
+     * @return \Salines\Verification\Transport\Sms\TransportInterface
      */
     private function createSmsTransport(): TransportInterface
     {
diff --git a/src/Service/VerificationServiceInterface.php b/src/Service/VerificationServiceInterface.php
@@ -24,7 +24,7 @@ interface VerificationServiceInterface
      * Identifies the current user (if any) from the request and determines pending steps.
      *
      * @param \Psr\Http\Message\ServerRequestInterface $request HTTP request
-     * @return \Verification\Value\VerificationResult Verification state (identity, pending steps, next route/URL)
+     * @return \Salines\Verification\Value\VerificationResult Verification state (identity, pending steps, next route/URL)
      */
     public function verify(ServerRequestInterface $request): VerificationResult;
 
@@ -46,7 +46,7 @@ public function getSteps(): array;
      * Resolve a verificator driver instance for a step.
      *
      * @param string $name Step name (e.g. "email_otp", "sms_otp", "totp")
-     * @return \Verification\Verificator\VerificationVerificatorInterface|null Driver instance or null if unmapped
+     * @return \Salines\Verification\Verificator\VerificationVerificatorInterface|null Driver instance or null if unmapped
      */
     public function getDriver(string $name): ?VerificationVerificatorInterface;
 
diff --git a/src/Transport/Sms/TransportInterface.php b/src/Transport/Sms/TransportInterface.php
@@ -6,8 +6,8 @@
 interface TransportInterface
 {
     /**
-     * @param \Verification\Transport\Sms\Message $message Message payload
-     * @return \Verification\Transport\Sms\Result
+     * @param \Salines\Verification\Transport\Sms\Message $message Message payload
+     * @return \Salines\Verification\Transport\Sms\Result
      */
     public function send(Message $message): Result;
 }
diff --git a/src/Verificator/Driver/SmsOtpVerificator.php b/src/Verificator/Driver/SmsOtpVerificator.php
@@ -27,7 +27,7 @@
 final class SmsOtpVerificator extends AbstractOtpVerificator
 {
     /**
-     * @param \Verification\Transport\Sms\TransportInterface $transport SMS transport
+     * @param \Salines\Verification\Transport\Sms\TransportInterface $transport SMS transport
      * @param array<string, mixed> $config Config
      */
     public function __construct(
diff --git a/tests/TestCase/Controller/Component/VerificationComponentChooseVerificationTest.php b/tests/TestCase/Controller/Component/VerificationComponentChooseVerificationTest.php
@@ -28,9 +28,9 @@ final class VerificationComponentChooseVerificationTest extends TestCase
      * Build a controller + component wired with the given request and mock service.
      *
      * @param \Cake\Http\ServerRequest $request
-     * @param \Verification\Service\VerificationServiceInterface&\PHPUnit\Framework\MockObject\MockObject $service
+     * @param \Salines\Verification\Service\VerificationServiceInterface&\PHPUnit\Framework\MockObject\MockObject $service
      * @param \Cake\ORM\Table|null $usersTable Optional stub table (needed for POST save path)
-     * @return \Verification\Controller\Component\VerificationComponent
+     * @return \Salines\Verification\Controller\Component\VerificationComponent
      */
     private function makeComponent(
         ServerRequest $request,
@@ -67,7 +67,7 @@ public function fetchTable(?string $alias = null, array $options = []): Table
      * Build a mock VerificationServiceInterface that reports the given available drivers.
      *
      * @param list<string> $drivers
-     * @return \Verification\Service\VerificationServiceInterface&\PHPUnit\Framework\MockObject\MockObject
+     * @return \Salines\Verification\Service\VerificationServiceInterface&\PHPUnit\Framework\MockObject\MockObject
      */
     private function makeService(array $drivers): VerificationServiceInterface&MockObject
     {
diff --git a/tests/TestCase/Security/CryptoFactoryTest.php b/tests/TestCase/Security/CryptoFactoryTest.php
@@ -9,7 +9,7 @@
 use Salines\Verification\Security\Driver\SodiumCrypto;
 
 /**
- * @covers \Verification\Security\CryptoFactory
+ * @covers \Salines\Verification\Security\CryptoFactory
  */
 final class CryptoFactoryTest extends TestCase
 {
diff --git a/tests/TestCase/Verificator/Driver/EmailOtpVerificatorTest.php b/tests/TestCase/Verificator/Driver/EmailOtpVerificatorTest.php
@@ -11,7 +11,7 @@
 use function Cake\I18n\__d;
 
 /**
- * @covers \Verification\Verificator\Driver\EmailOtpVerificator
+ * @covers \Salines\Verification\Verificator\Driver\EmailOtpVerificator
  */
 final class EmailOtpVerificatorTest extends TestCase
 {
diff --git a/tests/TestCase/Verificator/Driver/EmailVerifyVerificatorTest.php b/tests/TestCase/Verificator/Driver/EmailVerifyVerificatorTest.php
@@ -10,7 +10,7 @@
 use function Cake\I18n\__d;
 
 /**
- * @covers \Verification\Verificator\Driver\EmailVerifyVerificator
+ * @covers \Salines\Verification\Verificator\Driver\EmailVerifyVerificator
  */
 final class EmailVerifyVerificatorTest extends TestCase
 {
diff --git a/tests/TestCase/Verificator/Driver/SmsOtpVerificatorTest.php b/tests/TestCase/Verificator/Driver/SmsOtpVerificatorTest.php
@@ -12,7 +12,7 @@
 use function Cake\I18n\__d;
 
 /**
- * @covers \Verification\Verificator\Driver\SmsOtpVerificator
+ * @covers \Salines\Verification\Verificator\Driver\SmsOtpVerificator
  */
 final class SmsOtpVerificatorTest extends TestCase
 {
diff --git a/tests/TestCase/Verificator/Driver/TotpVerificatorTest.php b/tests/TestCase/Verificator/Driver/TotpVerificatorTest.php
@@ -10,7 +10,7 @@
 use function Cake\I18n\__d;
 
 /**
- * @covers \Verification\Verificator\Driver\TotpVerificator
+ * @covers \Salines\Verification\Verificator\Driver\TotpVerificator
  */
 final class TotpVerificatorTest extends TestCase
 {
diff --git a/tests/TestSuite/Stub/CaptureTransport.php b/tests/TestSuite/Stub/CaptureTransport.php
@@ -10,7 +10,7 @@
 final class CaptureTransport extends DummyTransport
 {
     /**
-     * @var array<int, \Verification\Transport\Sms\Message>
+     * @var array<int, \Salines\Verification\Transport\Sms\Message>
      */
     public array $sent = [];
 
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -24,7 +24,7 @@
 }
 
 if (isset($loader) && $loader instanceof ClassLoader) {
-    $loader->addPsr4('Salines\\Verification\\Test\\', $pluginRoot . '/tests/');
+    $loader->addPsr4('Salines\\Salines\Verification\\Test\\', $pluginRoot . '/tests/');
 }
 
 if (!function_exists('env')) {

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ final class CryptoFactory`
`24`	`24`	`* Create a crypto driver from the Verification.crypto config array.`
`25`	`25`	`*`
`26`	`26`	`* @param array<string, mixed> $config`
`27`		`- * @return \Verification\Security\CryptoInterface\|null null when crypto is not configured`
	`27`	`+ * @return \Salines\Verification\Security\CryptoInterface\|null null when crypto is not configured`
`28`	`28`	`*/`
`29`	`29`	`public static function create(array $config): ?CryptoInterface`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -401,7 +401,7 @@ private function isStepEnabled(string $step): bool`
`401`	`401`
`402`	`402`	`/**`
`403`	`403`	`* @param mixed $class`
`404`		`- * @return class-string<\Verification\Verificator\VerificationVerificatorInterface>\|null`
	`404`	`+ * @return class-string<\Salines\Verification\Verificator\VerificationVerificatorInterface>\|null`
`405`	`405`	`*/`
`406`	`406`	`private function normalizeDriverClass(mixed $class): ?string`
`407`	`407`	`{`
`@@ -446,7 +446,7 @@ private function extractIdentityData(IdentityInterface $identity): array`
`446`	`446`	`}`
`447`	`447`
`448`	`448`	`/**`
`449`		`- * @param class-string<\Verification\Verificator\VerificationVerificatorInterface> $class`
	`449`	`+ * @param class-string<\Salines\Verification\Verificator\VerificationVerificatorInterface> $class`
`450`	`450`	`* @param array<string, mixed> $config`
`451`	`451`	`*/`
`452`	`452`	`private function instantiateDriver(string $class, array $config): VerificationVerificatorInterface`
`@@ -461,7 +461,7 @@ private function instantiateDriver(string $class, array $config): VerificationVe`
`461`	`461`	`}`
`462`	`462`
`463`	`463`	`/**`
`464`		`- * @return \Verification\Transport\Sms\TransportInterface`
	`464`	`+ * @return \Salines\Verification\Transport\Sms\TransportInterface`
`465`	`465`	`*/`
`466`	`466`	`private function createSmsTransport(): TransportInterface`
`467`	`467`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,8 @@`
`6`	`6`	`interface TransportInterface`
`7`	`7`	`{`
`8`	`8`	`/**`
`9`		`- * @param \Verification\Transport\Sms\Message $message Message payload`
`10`		`- * @return \Verification\Transport\Sms\Result`
	`9`	`+ * @param \Salines\Verification\Transport\Sms\Message $message Message payload`
	`10`	`+ * @return \Salines\Verification\Transport\Sms\Result`
`11`	`11`	`*/`
`12`	`12`	`public function send(Message $message): Result;`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@`
`27`	`27`	`final class SmsOtpVerificator extends AbstractOtpVerificator`
`28`	`28`	`{`
`29`	`29`	`/**`
`30`		`- * @param \Verification\Transport\Sms\TransportInterface $transport SMS transport`
	`30`	`+ * @param \Salines\Verification\Transport\Sms\TransportInterface $transport SMS transport`
`31`	`31`	`* @param array<string, mixed> $config Config`
`32`	`32`	`*/`
`33`	`33`	`public function __construct(`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`use Salines\Verification\Security\Driver\SodiumCrypto;`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * @covers \Verification\Security\CryptoFactory`
	`12`	`+ * @covers \Salines\Verification\Security\CryptoFactory`
`13`	`13`	`*/`
`14`	`14`	`final class CryptoFactoryTest extends TestCase`
`15`	`15`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`use function Cake\I18n\__d;`
`12`	`12`
`13`	`13`	`/**`
`14`		`- * @covers \Verification\Verificator\Driver\EmailOtpVerificator`
	`14`	`+ * @covers \Salines\Verification\Verificator\Driver\EmailOtpVerificator`
`15`	`15`	`*/`
`16`	`16`	`final class EmailOtpVerificatorTest extends TestCase`
`17`	`17`	`{`