PHPStan Level 3 compat (#6044)

* PHPStan Level 3 compat

* Fix extra space

phpstan.neon.dist

@@ -1,5 +1,5 @@
 parameters:
-    level: 2
+    level: 3
     editorUrl: 'phpstorm://open?file=%%file%%&line=%%line%%'
     bootstrapFiles:
         - phpstan-bootstrap.php

src/Backend/BackendPathEvaluator.php

@@ -4,8 +4,8 @@
 
 namespace Drush\Backend;
 
-use Consolidation\SiteAlias\SiteAlias;
 use Consolidation\SiteAlias\HostPath;
+use Consolidation\SiteAlias\SiteAlias;
 use Drush\Drush;
 
 class BackendPathEvaluator
@@ -35,9 +35,8 @@ public function evaluate(HostPath $path)
      * returned.
      *
      * @param HostPath $path The host and path to resolve aliases on.
-     * @return string
      */
-    public function resolve(HostPath $path)
+    public function resolve(HostPath $path): string|false
     {
         if (!$path->hasPathAlias()) {
             return false;

src/Boot/BootstrapManager.php

@@ -131,6 +131,7 @@ public function bootstrap(): DrupalBoot8
         if (!$this->bootstrap) {
             $this->bootstrap = $this->bootstrapObjectForRoot($this->getRoot());
         }
+        assert($this->bootstrap instanceof DrupalBoot8);
         return $this->bootstrap;
     }
 

src/Commands/DrushCommands.php

@@ -63,6 +63,7 @@ protected function io(): DrushStyle
             // Specify our own Style class when needed.
             $this->io = new DrushStyle($this->input(), $this->output());
         }
+        assert($this->io instanceof DrushStyle);
         return $this->io;
     }
 
@@ -71,6 +72,7 @@ protected function io(): DrushStyle
      */
     public function logger(): ?DrushLoggerManager
     {
+        assert($this->logger instanceof DrushLoggerManager);
         return $this->logger;
     }
 

src/Commands/config/ConfigCommands.php

@@ -65,10 +65,7 @@ public function __construct(
         parent::__construct();
     }
 
-    /**
-     * @return StorageInterface
-     */
-    public function getConfigStorageExport()
+    public function getConfigStorageExport(): StorageManagerInterface|StorageCacheInterface
     {
         if (isset($this->configStorageExport)) {
             return $this->configStorageExport;

src/Commands/core/MigrateRunnerCommands.php

@@ -30,7 +30,7 @@
 use Symfony\Component\DependencyInjection\Attribute\Autowire;
 use Symfony\Component\Filesystem\Path;
 
-class MigrateRunnerCommands extends DrushCommands
+final class MigrateRunnerCommands extends DrushCommands
 {
     use AutowireTrait;
 

src/Commands/field/FieldBaseOverrideCreateCommands.php

@@ -176,6 +176,7 @@ protected function createBaseFieldOverride(string $entityType, string $bundle, s
             ->setRequired($isRequired)
             ->save();
 
+        assert($override instanceof BaseFieldOverride);
         return $override;
     }
 

src/Commands/field/FieldCreateCommands.php

@@ -498,9 +498,11 @@ protected function getEntityDisplay(string $context): ?EntityDisplayInterface
         $entityType = $this->input->getArgument('entityType');
         $bundle = $this->input->getArgument('bundle');
 
-        return $this->entityTypeManager
+        $return = $this->entityTypeManager
             ->getStorage(sprintf('entity_%s_display', $context))
             ->load(sprintf('%s.%s.default', $entityType, $bundle));
+        assert($return instanceof EntityDisplayInterface || $return === null);
+        return $return;
     }
 
     protected function logResult(FieldConfigInterface $field): void

src/Commands/field/FieldEntityReferenceHooks.php

@@ -10,7 +10,7 @@
 use Drush\Commands\DrushCommands;
 use Symfony\Component\Console\Input\InputInterface;
 
-class FieldEntityReferenceHooks extends DrushCommands
+final class FieldEntityReferenceHooks extends DrushCommands
 {
     use AutowireTrait;
     use EntityTypeBundleValidationTrait;

src/Commands/field/FieldTextHooks.php

@@ -15,7 +15,7 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 
-class FieldTextHooks extends DrushCommands
+final class FieldTextHooks extends DrushCommands
 {
     use AutowireTrait;
     use EntityTypeBundleValidationTrait;

src/Commands/help/ListCommands.php

@@ -178,7 +178,7 @@ public function renderListRaw(array $namespaced): void
     /**
      * @param Command[] $all
      *
-     * @return Command[]
+     * @return array<string, array<Command>>
      */
     public static function categorize(array $all, string $separator = ':'): array
     {

src/Commands/pm/PmCommands.php

@@ -192,6 +192,7 @@ public function validateUninstall(CommandData $commandData): void
             $modules = StringUtils::csvToArray($modules);
             if ($validation_reasons = $this->getModuleInstaller()->validateUninstall($modules)) {
                 foreach ($validation_reasons as $module => $reasons) {
+                    // @phpstan-ignore foreach.nonIterable
                     foreach ($reasons as $reason) {
                         $list[] = "$module: " . (string)$reason;
                     }

src/Commands/sql/sanitize/SanitizePluginInterface.php

@@ -26,11 +26,8 @@ public function sanitize($result, CommandData $commandData);
     /**
      * Use #[CLI\Hook(type: HookManager::ON_EVENT, target: SanitizeCommands::CONFIRMS)]
      *
-     * @param array $messages An array of messages to show during confirmation.
+     * @param array $messages An array of messages to show during confirmation. Make changes by reference.
      * @param InputInterface $input The effective commandline input for this request.
-     *
-     * @return String[]
-     *   An array of messages.
      */
     public function messages(array &$messages, InputInterface $input);
 }

src/Config/ConfigAwareTrait.php

@@ -15,11 +15,11 @@ trait ConfigAwareTrait
      * DrushConfig as return type. Helps with IDE completion.
      *
      * @see https://stackoverflow.com/a/37687295.
-     *
-     * @return DrushConfig
      */
-    public function getConfig()
+    public function getConfig(): DrushConfig
     {
-        return $this->parentGetConfig();
+        $return = $this->parentGetConfig();
+        assert($return instanceof DrushConfig, 'Expected DrushConfig, got ' . get_class($return) . '.');
+        return $return;
     }
 }

src/Config/ConfigLocator.php

@@ -4,7 +4,6 @@
 
 namespace Drush\Config;
 
-use Consolidation\Config\ConfigInterface;
 use Consolidation\Config\Loader\ConfigLoader;
 use Consolidation\Config\Loader\ConfigProcessor;
 use Consolidation\Config\Util\EnvConfig;
@@ -178,7 +177,7 @@ protected function addToSources(array $sources): void
      * Return the configuration object. Create it and load it with
      * all identified configuration if necessary.
      */
-    public function config(): ConfigInterface
+    public function config(): DrushConfig
     {
         return $this->config;
     }

src/Drush.php

@@ -287,7 +287,9 @@ public static function output(): OutputInterface
      */
     public static function drush(SiteAliasInterface $siteAlias, string $command, array $args = [], array $options = [], array $options_double_dash = []): SiteProcess
     {
-        return self::processManager()->drush($siteAlias, $command, $args, $options, $options_double_dash);
+        $return = self::processManager()->drush($siteAlias, $command, $args, $options, $options_double_dash);
+        assert($return instanceof SiteProcess);
+        return $return;
     }
 
     /**

src/Preflight/Preflight.php

@@ -240,7 +240,7 @@ public function config(): DrushConfig
      * @param $argv
      *   True if the request was successfully redispatched remotely. False if the request should proceed.
      *
-     * @return array{preflightDidRedispatch: bool, exitStatus: int}
+     * @return array{bool, int}
      */
     public function preflight($argv): array
     {

src/Runtime/LegacyServiceFinder.php

@@ -65,13 +65,12 @@ protected function addModuleDrushServiceProvider($module, $filename)
     }
 
     /**
-     * @param string $module Module name
-     * @param string $dir Full path to module base dir
+     * List of discovered drush.service.yml files
      *
-     * @return string[]
-     *   List of discovered drush.service.yml files
+     * @param $module Module name
+     * @param $dir Full path to module base dir
      */
-    protected function findModuleDrushServiceProvider($module, $dir)
+    protected function findModuleDrushServiceProvider(string $module, string $dir): string|null
     {
         $services = $this->findModuleDrushServiceProviderFromComposer($dir);
         if (!$services) {
@@ -81,11 +80,10 @@ protected function findModuleDrushServiceProvider($module, $dir)
     }
 
     /**
+     * Gets one discovered drush.service.yml file
+     *
      * @param string $module Module name
      * @param string $dir Full path to module base dir
-     *
-     * @return string
-     *   One discovered drush.service.yml file
      */
     protected function findDefaultServicesFile($module, $dir)
     {
@@ -97,6 +95,8 @@ protected function findDefaultServicesFile($module, $dir)
     }
 
     /**
+     * Get Drush services section from module's composer.json file
+     *
      * In composer.json, the Drush version constraints will appear
      * in the 'extra' section like so:
      *
@@ -113,11 +113,8 @@ protected function findDefaultServicesFile($module, $dir)
      * is used.
      *
      * @param string $dir Full path to module base dir
-     *
-     * @return array
-     *   Drush services section from module's composer.json file
      */
-    protected function findModuleDrushServiceProviderFromComposer($dir)
+    protected function findModuleDrushServiceProviderFromComposer($dir): array|false
     {
         $composerJsonPath = "$dir/composer.json";
         if (!file_exists($composerJsonPath)) {

src/Runtime/LegacyServiceInstantiator.php

@@ -218,10 +218,10 @@ protected function resolveArguments(array $arguments)
      *
      * @param array $arg Argument to resolve
      *
-     * @return object
+     * @return mixed
      *   Argument after it has been resolved by DI container
      */
-    protected function resolveArgument($arg)
+    protected function resolveArgument($arg): mixed
     {
         if (!is_string($arg)) {
             return $arg;
@@ -259,7 +259,7 @@ protected function resolveArgument($arg)
      * @param Container $container Drupal DI container
      * @param string $arg Argument to resolve
      *
-     * @return object
+     * @return ?object
      *   Resolved object from DI container
      */
     protected function resolveFromContainer($container, string $arg)
@@ -283,12 +283,12 @@ protected function resolveFromContainer($container, string $arg)
      * those that do not are required.
      *
      *
-     * @return bool, string
+     * @return array{bool, string}
      *   Boolean indicating whether the object is required to be in the container,
      *   and a string with the name of the object to look up (passed input with
      *   any leading ? removed).
      */
-    protected function isRequired(string $arg)
+    protected function isRequired(string $arg): array
     {
         if ($arg[0] === '?') {
             return [false, substr($arg, 1)];