refactor: fix PHPStan errors

phpstan-bootstrap.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 require __DIR__ . '/system/Test/bootstrap.php';
 
 if (! defined('OCI_COMMIT_ON_SUCCESS')) {

system/Autoloader/Autoloader.php

@@ -124,7 +124,7 @@ public function initialize(Autoload $config, Modules $modules)
             $this->files = $config->files;
         }
 
-        if (isset($config->helpers)) {
+        if ($config->helpers !== []) {
             $this->helpers = [...$this->helpers, ...$config->helpers];
         }
 
@@ -367,6 +367,9 @@ public function sanitizeFilename(string $filename): string
         return $cleanFilename;
     }
 
+    /**
+     * @param array{only?: list<string>, exclude?: list<string>} $composerPackages
+     */
     private function loadComposerNamespaces(ClassLoader $composer, array $composerPackages): void
     {
         $namespacePaths = $composer->getPrefixesPsr4();
@@ -380,7 +383,13 @@ private function loadComposerNamespaces(ClassLoader $composer, array $composerPa
             }
         }
 
-        if (! method_exists(InstalledVersions::class, 'getAllRawData')) {
+        preg_match(
+            '/\s*"plugin-api-version": "(?\'version\'\d+\.\d+\.\d+)"/m',
+            file_get_contents(__DIR__ . '/../../composer.lock'),
+            $matches
+        );
+
+        if (version_compare($matches['version'], '2.0.14', '<')) {
             throw new RuntimeException(
                 'Your Composer version is too old.'
                 . ' Please update Composer (run `composer self-update`) to v2.0.14 or later'

system/Autoloader/FileLocator.php

@@ -145,10 +145,10 @@ public function getClassname(string $file): string
 
             if ((isset($tokens[$i - 2][1]) && ($tokens[$i - 2][1] === 'phpnamespace' || $tokens[$i - 2][1] === 'namespace')) || ($dlm && $tokens[$i - 1][0] === T_NS_SEPARATOR && $token[0] === T_STRING)) {
                 if (! $dlm) {
-                    $namespace = 0;
+                    $namespace = '';
                 }
                 if (isset($token[1])) {
-                    $namespace = $namespace ? $namespace . '\\' . $token[1] : $token[1];
+                    $namespace = $namespace !== '' ? $namespace . '\\' . $token[1] : $token[1];
                     $dlm       = true;
                 }
             } elseif ($dlm && ($token[0] !== T_NS_SEPARATOR) && ($token[0] !== T_STRING)) {
@@ -194,8 +194,9 @@ public function search(string $path, string $ext = 'php', bool $prioritizeApp =
 
         foreach ($this->getNamespaces() as $namespace) {
             if (isset($namespace['path']) && is_file($namespace['path'] . $path)) {
-                $fullPath = $namespace['path'] . $path;
-                $fullPath = realpath($fullPath) ?: $fullPath;
+                $fullPath = ($realPath = realpath($namespace['path'] . $path)) !== false
+                    ? $realPath
+                    : ($namespace['path'] . $path);
 
                 if ($prioritizeApp) {
                     $foundPaths[] = $fullPath;
@@ -272,14 +273,14 @@ protected function getNamespaces()
      */
     public function findQualifiedNameFromPath(string $path)
     {
-        $path = realpath($path) ?: $path;
+        $path = ($realPath = realpath($path)) !== false ? $realPath : $path;
 
         if (! is_file($path)) {
             return false;
         }
 
         foreach ($this->getNamespaces() as $namespace) {
-            $namespace['path'] = realpath($namespace['path']) ?: $namespace['path'];
+            $namespace['path'] = ($realPath = realpath($namespace['path'])) !== false ? $realPath : $namespace['path'];
 
             if ($namespace['path'] === '') {
                 continue;
@@ -331,8 +332,9 @@ public function listFiles(string $path): array
         helper('filesystem');
 
         foreach ($this->getNamespaces() as $namespace) {
-            $fullPath = $namespace['path'] . $path;
-            $fullPath = realpath($fullPath) ?: $fullPath;
+            $fullPath = ($realPath = realpath($namespace['path'] . $path)) !== false
+                ? $realPath
+                : ($namespace['path'] . $path);
 
             if (! is_dir($fullPath)) {
                 continue;
@@ -366,7 +368,7 @@ public function listNamespaceFiles(string $prefix, string $path): array
         // autoloader->getNamespace($prefix) returns an array of paths for that namespace
         foreach ($this->autoloader->getNamespace($prefix) as $namespacePath) {
             $fullPath = rtrim($namespacePath, '/') . '/' . $path;
-            $fullPath = realpath($fullPath) ?: $fullPath;
+            $fullPath = ($realPath = realpath($fullPath)) !== false ? $realPath : $fullPath;
 
             if (! is_dir($fullPath)) {
                 continue;
@@ -393,7 +395,7 @@ public function listNamespaceFiles(string $prefix, string $path): array
     protected function legacyLocate(string $file, ?string $folder = null)
     {
         $path = APPPATH . ($folder === null ? $file : $folder . '/' . $file);
-        $path = realpath($path) ?: $path;
+        $path = ($realPath = realpath($path)) !== false ? $realPath : $path;
 
         if (is_file($path)) {
             return $path;

system/Autoloader/FileLocatorCached.php

@@ -86,6 +86,12 @@ public function deleteCache(): void
         $this->cacheHandler->delete($this->cacheKey);
     }
 
+    /**
+     * Find the qualified name of a file according to
+     * the namespace of the first matched namespace path.
+     *
+     * @return false|string The qualified name or false if the path is not found
+     */
     public function findQualifiedNameFromPath(string $path): false|string
     {
         if (isset($this->cache['findQualifiedNameFromPath'][$path])) {
@@ -100,6 +106,9 @@ public function findQualifiedNameFromPath(string $path): false|string
         return $classname;
     }
 
+    /**
+     * Examines a file and returns the fully qualified class name.
+     */
     public function getClassname(string $file): string
     {
         if (isset($this->cache['getClassname'][$file])) {
@@ -114,6 +123,21 @@ public function getClassname(string $file): string
         return $classname;
     }
 
+    /**
+     * Searches through all of the defined namespaces looking for a file.
+     * Returns an array of all found locations for the defined file.
+     *
+     * Example:
+     *
+     *  $locator->search('Config/Routes.php');
+     *  // Assuming PSR4 namespaces include foo and bar, might return:
+     *  [
+     *      'app/Modules/foo/Config/Routes.php',
+     *      'app/Modules/bar/Config/Routes.php',
+     *  ]
+     *
+     * @return list<string> List of file paths
+     */
     public function search(string $path, string $ext = 'php', bool $prioritizeApp = true): array
     {
         if (isset($this->cache['search'][$path][$ext][$prioritizeApp])) {
@@ -128,6 +152,12 @@ public function search(string $path, string $ext = 'php', bool $prioritizeApp =
         return $foundPaths;
     }
 
+    /**
+     * Scans the defined namespaces, returning a list of all files
+     * that are contained within the subpath specified by $path.
+     *
+     * @return list<string> List of file paths
+     */
     public function listFiles(string $path): array
     {
         if (isset($this->cache['listFiles'][$path])) {
@@ -142,6 +172,12 @@ public function listFiles(string $path): array
         return $files;
     }
 
+    /**
+     * Scans the provided namespace, returning a list of all files
+     * that are contained within the sub path specified by $path.
+     *
+     * @return list<string> List of file paths
+     */
     public function listNamespaceFiles(string $prefix, string $path): array
     {
         if (isset($this->cache['listNamespaceFiles'][$prefix][$path])) {
@@ -156,6 +192,21 @@ public function listNamespaceFiles(string $prefix, string $path): array
         return $files;
     }
 
+    /**
+     * Attempts to locate a file by examining the name for a namespace
+     * and looking through the PSR-4 namespaced files that we know about.
+     *
+     * @param string                $file   The relative file path or namespaced file to
+     *                                      locate. If not namespaced, search in the app
+     *                                      folder.
+     * @param non-empty-string|null $folder The folder within the namespace that we should
+     *                                      look for the file. If $file does not contain
+     *                                      this value, it will be appended to the namespace
+     *                                      folder.
+     * @param string                $ext    The file extension the file should have.
+     *
+     * @return false|string The path to the file, or false if not found.
+     */
     public function locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string
     {
         if (isset($this->cache['locateFile'][$file][$folder][$ext])) {

system/Autoloader/FileLocatorInterface.php

@@ -53,6 +53,8 @@ public function getClassname(string $file): string;
      *      'app/Modules/foo/Config/Routes.php',
      *      'app/Modules/bar/Config/Routes.php',
      *  ]
+     *
+     * @return list<string> List of file paths
      */
     public function search(string $path, string $ext = 'php', bool $prioritizeApp = true): array;