🔥 PHPStan!?

Author: codemasher

.github/workflows/ci.yml

@@ -1,6 +1,8 @@
 # https://help.github.com/en/categories/automating-your-workflow-with-github-actions
 # https://github.com/sebastianbergmann/phpunit/blob/master/.github/workflows/ci.yml
 
+name: "CI"
+
 on:
   push:
     branches:
@@ -10,7 +12,10 @@ on:
       - main
 
 
-name: "CI"
+env:
+  PHP_EXTENSIONS: json
+  PHP_INI_VALUES: memory_limit=-1, error_reporting=-1, display_errors=On
+
 
 jobs:
 
@@ -39,15 +44,15 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
-          tools: pecl
+          extensions: ${{ env.PHP_EXTENSIONS }}
+          ini-values: ${{ env.PHP_INI_VALUES }}
           coverage: none
-          extensions: ast, json
 
       - name: "Update dependencies with composer"
         uses: ramsey/composer-install@v3
 
-      - name: "Run phan"
-        run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
+      - name: "Run PHPStan"
+        run: php vendor/bin/phpstan
 
 
   build-docs:
@@ -103,8 +108,9 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
+          extensions: ${{ env.PHP_EXTENSIONS }}
+          ini-values: ${{ env.PHP_INI_VALUES }}
           coverage: pcov
-          extensions: json
 
       - name: "Install dependencies with composer"
         uses: ramsey/composer-install@v3

.gitignore

@@ -6,3 +6,4 @@ phpcs.xml
 phpdoc.xml
 phpmd.xml
 phpunit.xml
+phpstan.neon

.phan/config.php

@@ -24,24 +24,24 @@
 		"ext-json": "*"
 	},
 	"require-dev": {
-		"phan/phan": "^5.4",
 		"phpmd/phpmd": "^2.15",
+		"phpstan/phpstan": "^1.11",
 		"phpunit/phpunit": "^10.5",
 		"squizlabs/php_codesniffer": "^3.10"
 	},
 	"autoload": {
 		"psr-4": {
-			"chillerlan\\Settings\\": "src/"
+			"chillerlan\\Settings\\": "src"
 		}
 	},
 	"autoload-dev": {
 		"psr-4": {
-			"chillerlan\\SettingsTest\\": "tests/"
+			"chillerlan\\SettingsTest\\": "tests"
 		}
 	},
 	"scripts": {
 		"phpunit": "@php vendor/bin/phpunit",
-		"phan": "@php vendor/bin/phan"
+		"phpstan": "@php vendor/bin/phpstan"
 	},
 	"config": {
 		"lock": false,

composer.json

@@ -60,7 +60,7 @@ class MySettings extends SettingsContainerAbstract{
 	use SomeOptions, MoreOptions; // ...
 };
 
-$container = new MySettings($commonOptions);
+$container = new MySettings($commonOptions); // wtf phpstorm???
 
 var_dump($container->foo); // -> WHATEVER (constructor ran strtoupper on the value)
 var_dump($container->bar); // -> nothing

examples/advanced.php

@@ -10,18 +10,22 @@
 
 require_once __DIR__.'/../vendor/autoload.php';
 
+/**
+ * @property string $foo
+ * @property string $bar
+ */
 class MyContainer extends SettingsContainerAbstract{
 	protected string $foo;
 	protected string $bar;
 }
 
-/** @var \chillerlan\Settings\SettingsContainerInterface $container */
 $container = new MyContainer(['foo' => 'what']);
 $container->bar = 'foo';
 
 var_dump($container->toJSON()); // -> {"foo":"what","bar":"foo"}
 
 // non-existing properties will be ignored:
+/** @phpstan-ignore-next-line */
 $container->nope = 'what';
 
 var_dump($container->nope); // -> NULL

examples/simple.php

@@ -0,0 +1,12 @@
+# https://phpstan.org/config-reference
+
+parameters:
+	level: 9
+	paths:
+	- examples
+	- src
+	- tests
+	tmpDir: .build/phpstan-cache
+
+includes:
+	- phar://phpstan.phar/conf/bleedingEdge.neon

phpstan.dist.neon

@@ -11,15 +11,17 @@
 
 namespace chillerlan\Settings;
 
-use InvalidArgumentException, ReflectionClass, ReflectionProperty;
-use function array_keys, get_object_vars, is_object, json_decode,
-	json_encode, method_exists, property_exists, serialize, unserialize;
+use InvalidArgumentException, JsonException, ReflectionClass, ReflectionProperty;
+use function array_keys, get_object_vars, is_object, json_decode, json_encode,
+	json_last_error_msg, method_exists, property_exists, serialize, unserialize;
 use const JSON_THROW_ON_ERROR;
 
 abstract class SettingsContainerAbstract implements SettingsContainerInterface{
 
 	/**
 	 * SettingsContainerAbstract constructor.
+	 *
+	 * @phpstan-param array<string, mixed> $properties
 	 */
 	public function __construct(iterable|null $properties = null){
 
@@ -146,20 +148,28 @@ public function fromIterable(iterable $properties):static{
 	 * @inheritdoc
 	 */
 	public function toJSON(int|null $jsonOptions = null):string{
-		return json_encode($this, ($jsonOptions ?? 0));
+		$json = json_encode($this, ($jsonOptions ?? 0));
+
+		if($json === false){
+			throw new JsonException(json_last_error_msg());
+		}
+
+		return $json;
 	}
 
 	/**
 	 * @inheritdoc
 	 */
 	public function fromJSON(string $json):static{
+		/** @phpstan-var array<string, mixed> $data */
 		$data = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
 
 		return $this->fromIterable($data);
 	}
 
 	/**
 	 * @inheritdoc
+	 * @return array<string, mixed>
 	 */
 	public function jsonSerialize():array{
 		return $this->toArray();
@@ -228,6 +238,8 @@ public function __serialize():array{
 	 *
 	 * @inheritdoc
 	 * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable()
+	 *
+	 * @param array<string, mixed> $data
 	 */
 	public function __unserialize(array $data):void{
 

src/SettingsContainerAbstract.php

@@ -49,29 +49,37 @@ public function __toString():string;
 	 * Returns an array representation of the settings object
 	 *
 	 * The values will be run through the magic __get(), which may also call custom getters.
+	 *
+	 * @return array<string, mixed>
 	 */
 	public function toArray():array;
 
 	/**
 	 * Sets properties from a given iterable
 	 *
 	 * The values will be run through the magic __set(), which may also call custom setters.
+	 *
+	 *  @phpstan-param array<string, mixed> $properties
 	 */
 	public function fromIterable(iterable $properties):static;
 
 	/**
 	 * Returns a JSON representation of the settings object
+	 *
 	 * @see \json_encode()
 	 * @see \chillerlan\Settings\SettingsContainerInterface::toArray()
+	 *
+	 * @throws \JsonException
 	 */
 	public function toJSON(int|null $jsonOptions = null):string;
 
 	/**
 	 * Sets properties from a given JSON string
 	 *
+	 * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable()
+	 *
 	 * @throws \Exception
 	 * @throws \JsonException
-	 * @see \chillerlan\Settings\SettingsContainerInterface::fromIterable()
 	 */
 	public function fromJSON(string $json):static;
 

src/SettingsContainerInterface.php

@@ -27,6 +27,7 @@ public function testConstruct():void{
 
 		$this::assertSame('test1', $container->test1);
 		$this::assertSame(true, $container->test2);
+		/** @phpstan-ignore-next-line */
 		$this::assertNull($container->test3);
 		$this::assertSame('test4', $container->test4);
 
@@ -38,13 +39,16 @@ public function testGet():void{
 
 		$this::assertSame('foo', $container->test1);
 		$this::assertNull($container->test2);
+		/** @phpstan-ignore-next-line */
 		$this::assertNull($container->test3);
 		$this::assertNull($container->test4);
+		/** @phpstan-ignore-next-line */
 		$this::assertNull($container->foo);
 
 		// isset test
 		$this::assertTrue(isset($container->test1));
 		$this::assertFalse(isset($container->test2));
+		/** @phpstan-ignore-next-line */
 		$this::assertFalse(isset($container->test3));
 		$this::assertFalse(isset($container->test4));
 		$this::assertFalse(isset($container->foo));
@@ -62,10 +66,12 @@ public function testSet():void{
 		$container = new TestContainer;
 		$container->test1 = 'bar';
 		$container->test2 = false;
+		/** @phpstan-ignore-next-line */
 		$container->test3 = 'nope';
 
 		$this::assertSame('bar', $container->test1);
 		$this::assertSame(false, $container->test2);
+		/** @phpstan-ignore-next-line */
 		$this::assertNull($container->test3);
 
 		// unset
@@ -130,6 +136,7 @@ public function testSerializable():void{
 			'testConstruct' => 'success',
 		]);
 
+		/** @var \chillerlan\SettingsTest\TestContainer $container */
 		$container = unserialize(serialize($container)); // object should remain in the same state
 
 		// serialize will return the object in its current state including private properties

tests/ContainerTest.php

@@ -16,5 +16,6 @@
 class TestContainer extends SettingsContainerAbstract{
 	use TestOptionsTrait;
 
+	/** @phpstan-ignore-next-line */
 	private string $test3 = 'what';
 }

tests/TestContainer.php

@@ -13,6 +13,14 @@
 
 use function sha1;
 
+/**
+ * @property string      $test1
+ * @property bool|null   $test2
+ * @property string      $testConstruct
+ * @property string|null $test4
+ * @property string      $test5
+ * @property string|null $test6
+ */
 trait TestOptionsTrait{
 
 	protected string $test1 = 'foo';