Apply property types

Author: MGatner

UPGRADING.md

@@ -5,6 +5,8 @@
 
 > Note: This is a complete refactor! Please be sure to read the docs carefully before upgrading.
 
+* Minimum PHP version has been bumped to `7.4` to match the upcoming framework changes
+* All properties that can be typed have been
 * The services no longer exist; remove all references to `Services::Assets` and `Services::manifests` to avoid exceptions
 * This library no longer publishes Assets; convert Manifests to the framework's new [Publisher format](https://codeigniter.com/user_guide/libraries/publisher.html)
 * Many of the example Manifests now have an official Publisher equivalent at [Tatter\Frontend](https://github.com/tattersoftware/codeigniter4-frontend)

src/Bundle.php

@@ -23,35 +23,35 @@ abstract class Bundle
      *
      * @var Asset[]
      */
-    protected $assets = [];
+    protected array $assets = [];
 
     /**
      * Bundle classes to merge with this Bundle.
      *
      * @var string[]
      */
-    protected $bundles = [];
+    protected array $bundles = [];
 
     /**
      * Paths to include in this Bundle.
      *
      * @var string[]
      */
-    protected $paths = [];
+    protected array $paths = [];
 
     /**
      * URIs to include in this Bundle.
      *
      * @var string[]
      */
-    protected $uris = [];
+    protected array $uris = [];
 
     /**
      * Strings to include in this Bundle.
      *
      * @var string[]
      */
-    protected $strings = [];
+    protected array $strings = [];
 
     //--------------------------------------------------------------------
     // Asset Handling

src/Config/Assets.php

@@ -14,42 +14,32 @@ class Assets extends BaseConfig
 
     /**
      * Asset URI base, relative to baseURL.
-     *
-     * @var string
      */
-    public $uri = 'assets/';
+    public string $uri = 'assets/';
 
     /**
      * Asset storage location in the filesystem.
      * Must be somewhere web accessible.
-     *
-     * @var string
      */
-    public $directory = FCPATH . 'assets/';
+    public string $directory = FCPATH . 'assets/';
 
     /**
      * Path for third-party published Assets. The path is relative to
      * both $directory and $uri. Recommended to add the resulting file
      * path to .gitignore so published vendor assets will not be tracked.
-     *
-     * @var string
      */
-    public $vendor = 'vendor/';
+    public string $vendor = 'vendor/';
 
     /**
      * Whether to append file modification timestamps on asset tags.
      * Makes it less likely for modified assets to remain cached.
-     *
-     * @var bool
      */
-    public $useTimestamps = true;
+    public bool $useTimestamps = true;
 
     /**
      * Whether to cache bundles for faster route responses.
-     *
-     * @var bool
      */
-    public $useCache = ENVIRONMENT === 'production';
+    public bool $useCache = ENVIRONMENT === 'production';
 
     //--------------------------------------------------------------------
     // Route Assets
@@ -77,7 +67,7 @@ class Assets extends BaseConfig
      *
      * @var array<string,string[]>
      */
-    public $routes = [];
+    public array $routes = [];
 
     /**
      * Gathers Assets and Bundles that match the relative URI path.

src/Test/AssetsTestTrait.php

@@ -18,22 +18,15 @@ trait AssetsTestTrait
 {
     /**
      * The virtual workspace.
-     *
-     * @var vfsStreamDirectory|null
      */
-    protected static $root;
+    protected static ?vfsStreamDirectory $root = null;
 
     /**
      * Whether the publishers have been run.
-     *
-     * @var bool
      */
-    private static $published = false;
+    private static bool $published = false;
 
-    /**
-     * @var AssetsConfig
-     */
-    protected $assets;
+    protected AssetsConfig $assets;
 
     /**
      * Creates the VFS (if necessary) and updates the Assets config.

tests/BundleTest.php

@@ -12,8 +12,8 @@ final class BundleTest extends TestCase
 {
     public function testConstructorPaths()
     {
-        $bundle              = new class () extends Bundle {
-            protected $paths = ['apple.css'];
+        $bundle                    = new class () extends Bundle {
+            protected array $paths = ['apple.css'];
         };
 
         $assets = $bundle->getAssets();
@@ -25,8 +25,8 @@ public function testConstructorPaths()
 
     public function testConstructorBundles()
     {
-        $bundle                = new class () extends Bundle {
-            protected $bundles = [FruitSalad::class];
+        $bundle                      = new class () extends Bundle {
+            protected array $bundles = [FruitSalad::class];
         };
 
         $assets = $bundle->getAssets();
@@ -38,8 +38,8 @@ public function testConstructorBundles()
 
     public function testConstructorStrings()
     {
-        $bundle                = new class () extends Bundle {
-            protected $strings = ['foobar'];
+        $bundle                      = new class () extends Bundle {
+            protected array $strings = ['foobar'];
         };
 
         $assets = $bundle->getAssets();
@@ -51,17 +51,17 @@ public function testConstructorStrings()
 
     public function testStringable()
     {
-        $asset               = new class () extends Bundle {
-            protected $paths = ['apple.css'];
+        $asset                     = new class () extends Bundle {
+            protected array $paths = ['apple.css'];
         };
 
         $this->assertSame('<link href="https://example.com/assets/apple.css" rel="stylesheet" type="text/css" />', (string) $asset);
     }
 
     public function testHead()
     {
-        $asset               = new class () extends Bundle {
-            protected $paths = [
+        $asset                     = new class () extends Bundle {
+            protected array $paths = [
                 'apple.css',
                 'banana.js',
             ];

tests/_support/Bundles/FruitSalad.php

@@ -11,7 +11,7 @@ class FruitSalad extends Bundle
      *
      * @var string[]
      */
-    protected $paths = [
+    protected array $paths = [
         'apple.css',
         'banana.js',
     ];

tests/_support/Bundles/LunchBreak.php

@@ -11,7 +11,7 @@ class LunchBreak extends Bundle
      *
      * @var string[]
      */
-    protected $paths = [
+    protected array $paths = [
         'banana.js',
         'directory/machines.js',
     ];
@@ -21,7 +21,7 @@ class LunchBreak extends Bundle
      *
      * @var string[]
      */
-    protected $uris = [
+    protected array $uris = [
         'https://water.com/glassof.css',
     ];
 }

tests/_support/TestCase.php

@@ -8,10 +8,7 @@
 
 abstract class TestCase extends CIUnitTestCase
 {
-    /**
-     * @var AssetsConfig
-     */
-    protected $assets;
+    protected AssetsConfig $assets;
 
     /**
      * Preps the config for the test directory.