Clean up type declarations

Author: john-shaffer

src/AdminBar.php

@@ -254,7 +254,7 @@ public static function listInvalidations( int $max_items = 5 ) {
         }
     }
 
-    public static function listInvalidationsInProgress( int $max_items = 5 ) {
+    public static function listInvalidationsInProgress( int $max_items = 5 ): ?array {
         $invalidations = self::listInvalidations( $max_items );
         if ( ! $invalidations ) {
             return null;

src/CLI/Args.php

@@ -6,6 +6,9 @@
 use WP_CLI;
 
 class Args {
+    /**
+     * @param array<int, mixed> $args
+     */
     public static function parse(
         array $args,
         ?array $assoc_args = null,

src/CrawledFiles.php

@@ -195,7 +195,7 @@ public static function removeOutdated( \Iterator $paths ): \Iterator {
                 // Delete previously generated files under the directories,
                 // both the crawled and the processed.
                 array_map(
-                    function ( $dir ) use ( $path ): void {
+                    function ( string $dir ) use ( $path ): void {
                         $file_path = FilesHelper::getFilePath( $dir, $path->path );
                         $suffix = ltrim( $file_path, '/' );
                         $full_path = trailingslashit( $dir ) . $suffix;

src/Crawler.php

@@ -25,22 +25,13 @@
 
 class Crawler {
 
-    /**
-     * @var Client
-     */
-    private $client;
+    private readonly \GuzzleHttp\Client $client;
 
     private readonly Uri $site_uri;
 
-    /**
-     * @var integer
-     */
-    private $crawled = 0;
+    private int $crawled = 0;
 
-    /**
-     * @var integer
-     */
-    private $cache_hits = 0;
+    private int $cache_hits = 0;
 
     private int $concurrency;
 
@@ -145,6 +136,9 @@ public function crawlComplete(): void {
         do_action( Controller::getHookName( 'crawling_complete' ), $args );
     }
 
+    /**
+     * @param string[] $site_urls
+     */
     public function crawlPath( PathInfo $detected, array $site_urls ): PromiseInterface {
         $absolute_uri = URLHelper::normalize( $this->site_uri . $detected->path );
         try {
@@ -158,7 +152,7 @@ public function crawlPath( PathInfo $detected, array $site_urls ): PromiseInterf
         }
 
         return $this->client->sendAsync( $request )->then(
-            function ( $response ) use ( &$detected, &$site_urls ) {
+            function ( $response ) use ( &$detected, &$site_urls ): array {
                 $status = $response->getStatusCode();
 
                 if ( in_array( $status, STATIC_DEPLOY_REDIRECT_CODES, true ) ) {
@@ -202,7 +196,7 @@ function ( $response ) use ( &$detected, &$site_urls ) {
                     'path' => $path_info,
                 ];
             },
-            function () use ( &$detected ) {
+            function () use ( &$detected ): array {
                 return [
                     'error' => 'Error crawling ' . $detected->path,
                     'path' => $detected,

src/DetectPluginAssets.php

@@ -41,7 +41,7 @@ public static function detect(
             }
 
             $active_plugin_dirs = array_map(
-                function ( $active_plugin ) {
+                function ( int|string $active_plugin ): string {
                     $dir = explode( '/', $active_plugin )[0];
                     if ( STATIC_DEPLOY_DEBUG ) {
                         WsLog::d( "Active plugin dir: {$dir}" );

src/DirectDeployer.php

@@ -8,12 +8,12 @@
 namespace StaticDeploy;
 
 class DirectDeployer {
-    private $crawler;
-    private $deployer;
+    private readonly Crawler $crawler;
+    private readonly object $deployer;
     public DirectDeployConfig $config;
-    private $processor;
+    private readonly PostProcessor $processor;
     public bool $ready = false;
-    private $url_discovery;
+    private readonly URLDiscovery $url_discovery;
 
     public function __construct(
         ?DirectDeployConfig $config = null,

src/FileFiltering.php

@@ -8,7 +8,7 @@ class FileFiltering {
      * @var array<FileIgnorePattern>
      * Files and directories to ignore
      */
-    private $patterns_to_ignore = [];
+    private array $patterns_to_ignore = [];
 
     public function __construct() {
         $paths_to_ignore = Options::getLineDelimitedBlobValue( 'pathsToIgnore' );
@@ -38,7 +38,7 @@ public function crawlableFiles(
         $filter_iter = new \RecursiveCallbackFilterIterator(
             $dir_iter,
             // phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter
-            function ( $current, $key, $iterator ) use ( $abs_base_dir ) {
+            function ( $current, $key, $iterator ) use ( $abs_base_dir ): bool {
                 // Filter out both directories and files
                 foreach ( $this->patterns_to_ignore as $pattern_to_ignore ) {
                     if ( $pattern_to_ignore->matches( $abs_base_dir, $current ) ) {

src/FileIgnorePattern.php

@@ -10,13 +10,13 @@ class FileIgnorePattern {
      * @var bool
      * Match only directories and not files.
      */
-    private $only_directories;
+    private bool $only_directories;
 
     /**
      * @var string
      * Regex tested against relative URLs.
      */
-    private $url_regex;
+    private readonly string $url_regex;
 
     /**
      * Following gitignore rules:

src/JobQueue.php

@@ -267,7 +267,7 @@ public static function setStatus( int $id, string $status ): void {
         Db::query(
             $query,
             // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter
-            on_error: function ( $error ) use ( $query ) {
+            on_error: function ( $error ) use ( $query ): int|bool {
                 // Try to create status_update_at column
                 self::createTable();
                 return Db::query( $query );

src/Local/LocalDeployer.php

@@ -14,25 +14,19 @@ class LocalDeployer {
 
     const DEFAULT_NAMESPACE = 'static-deploy-addon-local/default';
 
-    /**
-     * @var integer
-     */
-    private $deployed_ct = 0;
+    private int $deployed_ct = 0;
 
-    /**
-     * @var integer
-     */
-    private $deploy_cache_ct = 0;
+    private int $deploy_cache_ct = 0;
 
-    /**
-     * @var integer
-     */
-    private $deploy_error_ct = 0;
+    private int $deploy_error_ct = 0;
 
     public static function getDeployerSlug(): string {
         return 'static-deploy-addon-local';
     }
 
+    /**
+     * @return array<string, string>
+     */
     public static function getDeployerData(): array {
         return [
             'description' => 'Deploys to a local directory',