PHP 8.1+

Author: codemasher

.github/workflows/tests.yml

@@ -30,17 +30,18 @@ jobs:
       - name: "Install PHP"
         uses: shivammathur/setup-php@v2
         with:
-          php-version: "7.4"
+          php-version: "8.1"
           tools: pecl
           coverage: none
           extensions: ast, json
 
       - name: "Update dependencies with composer"
-        run: composer update --no-interaction --no-ansi --no-progress --no-suggest
+        uses: ramsey/composer-install@v2
 
       - name: "Run phan"
         run: php vendor/bin/phan
 
+
   build-docs:
     name: "Build and publish Docs"
 
@@ -68,6 +69,7 @@ jobs:
           folder: docs
           clean: true
 
+
   tests:
     name: "Unit Tests"
 
@@ -80,9 +82,9 @@ jobs:
           - ubuntu-latest
           - windows-latest
         php-version:
-          - "7.4"
           - "8.0"
           - "8.1"
+          - "8.2"
 
     steps:
       - name: "Checkout"
@@ -96,7 +98,7 @@ jobs:
           extensions: json
 
       - name: "Install dependencies with composer"
-        run: composer update --no-ansi --no-interaction --no-progress --no-suggest
+        uses: ramsey/composer-install@v2
 
       - name: "Run tests with phpunit"
         run: php vendor/phpunit/phpunit/phpunit --configuration=phpunit.xml

.scrutinizer.yml

@@ -5,7 +5,7 @@ build:
         override:
           - php-scrutinizer-run
   environment:
-    php: 8.0.0
+    php: 8.1.0
 
 filter:
   excluded_paths:

README.md

@@ -1,6 +1,6 @@
 # chillerlan/php-settings-container
 
-A container class for immutable settings objects. Not a DI container. PHP 7.4+
+A container class for immutable settings objects. Not a DI container. PHP 8.1+
 - [`SettingsContainerInterface`](https://github.com/chillerlan/php-settings-container/blob/main/src/SettingsContainerInterface.php) provides immutable properties with magic getter & setter and some fancy - decouple configuration logic from your application!
 
 [![PHP Version Support][php-badge]][php]
@@ -35,7 +35,7 @@ A container class for immutable settings objects. Not a DI container. PHP 7.4+
 ```json
 {
 	"require": {
-		"php": "^7.4 || ^8.0",
+		"php": "^8.1",
 		"chillerlan/php-settings-container": "dev-main"
 	}
 }
@@ -50,13 +50,6 @@ It takes an `iterable` as the only constructor argument and calls a method with
 
 ### Simple usage
 ```php
-class MyContainer extends SettingsContainerAbstract{
-	protected $foo;
-	protected $bar;
-}
-```
-Typed properties in PHP 7.4+:
-```php
 class MyContainer extends SettingsContainerAbstract{
 	protected string $foo;
 	protected string $bar;
@@ -91,8 +84,8 @@ var_dump($container->nope); // -> null
 ### Advanced usage
 ```php
 trait SomeOptions{
-	protected $foo;
-	protected $what;
+	protected string $foo;
+	protected string $what;
 
 	// this method will be called in SettingsContainerAbstract::construct()
 	// after the properties have been set
@@ -108,7 +101,7 @@ trait SomeOptions{
 }
 
 trait MoreOptions{
-	protected $bar = 'whatever'; // provide default values
+	protected string $bar = 'whatever'; // provide default values
 }
 ```
 

composer.json

@@ -20,11 +20,11 @@
 		"source": "https://github.com/chillerlan/php-settings-container"
 	},
 	"require": {
-		"php": "^7.4 || ^8.0",
+		"php": "^8.1",
 		"ext-json": "*"
 	},
 	"require-dev": {
-		"phan/phan": "^5.3",
+		"phan/phan": "^5.4",
 		"phpunit/phpunit": "^9.5"
 	},
 	"autoload": {

examples/advanced.php

@@ -17,7 +17,7 @@ trait SomeOptions{
 	protected string $foo = '';
 
 	// this method will be called in SettingsContainerAbstract::__construct() after the properties have been set
-	protected function SomeOptions(){
+	protected function SomeOptions():void{
 		// just some constructor stuff...
 		$this->foo = strtoupper($this->foo);
 	}

examples/simple.php

@@ -13,8 +13,8 @@
 require_once __DIR__.'/../vendor/autoload.php';
 
 class MyContainer extends SettingsContainerAbstract{
-	protected $foo;
-	protected $bar;
+	protected string $foo;
+	protected string $bar;
 }
 
 /** @var \chillerlan\Settings\SettingsContainerInterface $container */

src/SettingsContainerAbstract.php

@@ -49,7 +49,7 @@ protected function construct():void{
 	/**
 	 * @inheritdoc
 	 */
-	public function __get(string $property){
+	public function __get(string $property):mixed{
 
 		if(!property_exists($this, $property) || $this->isPrivate($property)){
 			return null;
@@ -67,7 +67,7 @@ public function __get(string $property){
 	/**
 	 * @inheritdoc
 	 */
-	public function __set(string $property, $value):void{
+	public function __set(string $property, mixed $value):void{
 
 		if(!property_exists($this, $property) || $this->isPrivate($property)){
 			return;
@@ -153,9 +153,9 @@ public function fromJSON(string $json):SettingsContainerInterface{
 
 	/**
 	 * @inheritdoc
+	 * @noinspection PhpMixedReturnTypeCanBeReducedInspection
 	 */
-	#[\ReturnTypeWillChange]
-	public function jsonSerialize():array{
+	public function jsonSerialize():mixed{
 		return $this->toArray();
 	}
 

src/SettingsContainerInterface.php

@@ -22,15 +22,12 @@ interface SettingsContainerInterface extends JsonSerializable{
 	 *
 	 * @return mixed|null
 	 */
-	public function __get(string $property);
+	public function __get(string $property):mixed;
 
 	/**
 	 * Set $property to $value while avoiding private and non-existing properties
-	 *
-	 * @param string $property
-	 * @param mixed  $value
 	 */
-	public function __set(string $property, $value):void;
+	public function __set(string $property, mixed $value):void;
 
 	/**
 	 * Checks if $property is set (aka. not null), excluding private properties

tests/ContainerTest.php

@@ -16,7 +16,7 @@
 
 class ContainerTest extends TestCase{
 
-	public function testConstruct(){
+	public function testConstruct():void{
 		$container = new TestContainer([
 			'test1' => 'test1',
 			'test2' => true,
@@ -32,7 +32,7 @@ public function testConstruct(){
 		$this::assertSame('success', $container->testConstruct);
 	}
 
-	public function testGet(){
+	public function testGet():void{
 		$container = new TestContainer;
 
 		$this::assertSame('foo', $container->test1);
@@ -57,7 +57,7 @@ public function testGet(){
 		$this::assertSame('null', $container->test6);
 	}
 
-	public function testSet(){
+	public function testSet():void{
 		$container = new TestContainer;
 		$container->test1 = 'bar';
 		$container->test2 = false;
@@ -76,7 +76,7 @@ public function testSet(){
 		$this::assertSame('bar_test5', $container->test5);
 	}
 
-	public function testToArray(){
+	public function testToArray():void{
 		$container = new TestContainer([
 			'test1'         => 'no',
 			'test2'         => true,
@@ -93,7 +93,7 @@ public function testToArray(){
 		], $container->toArray());
 	}
 
-	public function testToJSON(){
+	public function testToJSON():void{
 		$container = (new TestContainer)->fromJSON('{"test1":"no","test2":true,"testConstruct":"success"}');
 
 		$expected  = '{"test1":"no","test2":true,"testConstruct":"success","test4":null,"test5":null,"test6":null}';
@@ -102,12 +102,13 @@ public function testToJSON(){
 		$this::assertSame($expected, (string)$container);
 	}
 
-	public function testFromJsonException(){
+	public function testFromJsonException():void{
 		$this->expectException(JsonException::class);
 		(new TestContainer)->fromJSON('-');
 
 	}
-	public function testFromJsonTypeError(){
+
+	public function testFromJsonTypeError():void{
 		$this->expectException(TypeError::class);
 		(new TestContainer)->fromJSON('2');
 	}

tests/TestContainer.php

@@ -12,14 +12,6 @@
 
 use chillerlan\Settings\SettingsContainerAbstract;
 
-/**
- * @property $test1
- * @property $test2
- * @property $test3
- * @property $test4
- * @property $test5
- * @property $test6
- */
 class TestContainer extends SettingsContainerAbstract{
 	use TestOptionsTrait;