AccessResult stubs (#573)

Author: mglaman

stubs/Drupal/Core/Access/AccessResult.stub

@@ -0,0 +1,21 @@
+<?php
+
+namespace Drupal\Core\Access;
+
+use Drupal\Core\Cache\RefinableCacheableDependencyInterface;
+
+abstract class AccessResult implements AccessResultInterface, RefinableCacheableDependencyInterface {
+
+    /**
+     * @return ($condition is true ? \Drupal\Core\Access\AccessResultAllowed : \Drupal\Core\Access\AccessResultNeutral)
+     */
+    public static function allowedIf(bool $condition) {
+    }
+
+    /**
+     * @return ($condition is true ? \Drupal\Core\Access\AccessResultForbidden : \Drupal\Core\Access\AccessResultNeutral)
+     */
+    public static function forbiddenIf(bool $condition, ?string $reason = NULL) {
+    }
+
+}

stubs/Drupal/Core/Access/AccessResultAllowed.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Access;
+
+class AccessResultAllowed extends AccessResult {
+}

stubs/Drupal/Core/Access/AccessResultForbidden.stub

@@ -0,0 +1,7 @@
+<?php
+
+namespace Drupal\Core\Access;
+
+class AccessResultForbidden extends AccessResult implements AccessResultReasonInterface {
+
+}

stubs/Drupal/Core/Access/AccessResultNeutral.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Access;
+
+class AccessResultNeutral extends AccessResult implements AccessResultReasonInterface {
+}

stubs/Drupal/Core/Access/AccessResultReasonInterface.stub

@@ -0,0 +1,6 @@
+<?php
+
+namespace Drupal\Core\Access;
+
+interface AccessResultReasonInterface extends AccessResultInterface {
+}

tests/src/Type/AccessResultTypeTest.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace mglaman\PHPStanDrupal\Tests\Type;
+
+use mglaman\PHPStanDrupal\Tests\AdditionalConfigFilesTrait;
+use PHPStan\Testing\TypeInferenceTestCase;
+
+final class AccessResultTypeTest extends TypeInferenceTestCase
+{
+    use AdditionalConfigFilesTrait;
+
+    public function dataFileAsserts(): iterable
+    {
+        yield from self::gatherAssertTypes(__DIR__ . '/data/access-result.php');
+    }
+
+    /**
+     * @dataProvider dataFileAsserts
+     * @param string $assertType
+     * @param string $file
+     * @param mixed ...$args
+     */
+    public function testFileAsserts(
+        string $assertType,
+        string $file,
+        ...$args
+    ): void
+    {
+        $this->assertFileAsserts($assertType, $file, ...$args);
+    }
+}

tests/src/Type/data/access-result.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace AccessResultType;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Access\AccessResultAllowed;
+use Drupal\Core\Access\AccessResultForbidden;
+use Drupal\Core\Access\AccessResultNeutral;
+use function PHPStan\Testing\assertType;
+
+assertType(AccessResultAllowed::class, AccessResult::allowedIf(true));
+assertType(AccessResultNeutral::class, AccessResult::allowedIf(false));
+
+assertType(AccessResultForbidden::class, AccessResult::forbiddenIf(true));
+assertType(AccessResultNeutral::class, AccessResult::forbiddenIf(false));