Add basic phpstan level 1 config/ci

Author: Seldaek

.github/workflows/phpstan.yml

@@ -0,0 +1,34 @@
+name: "PHPStan"
+
+on:
+  - push
+  - pull_request
+
+env:
+  COMPOSER_FLAGS: "--ansi --no-interaction --no-progress --prefer-dist"
+
+jobs:
+  tests:
+    name: "PHPStan"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          extensions: "intl, zip"
+          ini-values: "memory_limit=-1"
+          php-version: "7.4"
+
+      - name: "Update dependencies"
+        run: "composer update ${{ env.COMPOSER_FLAGS }}"
+
+      - name: Run PHPStan
+        run: |
+          composer require --dev phpstan/phpstan:^0.12.93 marc-mabe/php-enum-phpstan ${{ env.COMPOSER_FLAGS }}
+          vendor/bin/phpstan analyse

phpstan-baseline.neon

@@ -0,0 +1,12 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^PHPDoc tag @throws with type JsonSchema\\\\Exception\\\\ExceptionInterface is not subtype of Throwable$#"
+			count: 1
+			path: src/JsonSchema/Constraints/ConstraintInterface.php
+
+		-
+			message: "#^Access to an undefined property object\\:\\:\\$properties\\.$#"
+			count: 3
+			path: src/JsonSchema/SchemaStorage.php
+

phpstan.neon

@@ -0,0 +1,9 @@
+parameters:
+    level: 2
+    paths:
+        - ./src/
+    ignoreErrors: []
+
+includes:
+    - phpstan-baseline.neon
+    - vendor/marc-mabe/php-enum-phpstan/extension.neon

src/JsonSchema/Constraints/Constraint.php

@@ -87,6 +87,7 @@ protected function checkArray(&$value, $schema = null, JsonPointer $path = null,
     protected function checkObject(&$value, $schema = null, JsonPointer $path = null, $properties = null,
         $additionalProperties = null, $patternProperties = null, $appliedDefaults = array())
     {
+        /** @var ObjectConstraint $validator */
         $validator = $this->factory->createInstanceFor('object');
         $validator->check($value, $schema, $path, $properties, $additionalProperties, $patternProperties, $appliedDefaults);
 
@@ -119,6 +120,7 @@ protected function checkType(&$value, $schema = null, JsonPointer $path = null,
      */
     protected function checkUndefined(&$value, $schema = null, JsonPointer $path = null, $i = null, $fromDefault = false)
     {
+        /** @var UndefinedConstraint $validator */
         $validator = $this->factory->createInstanceFor('undefined');
 
         $validator->check($value, $this->factory->getSchemaStorage()->resolveRefSchema($schema), $path, $i, $fromDefault);

src/JsonSchema/Constraints/Factory.php

@@ -185,6 +185,7 @@ public function setConstraintClass($name, $class)
      * @throws InvalidArgumentException if is not possible create the constraint instance
      *
      * @return ConstraintInterface|ObjectConstraint
+     * @phpstan-return ConstraintInterface&BaseConstraint
      */
     public function createInstanceFor($constraintName)
     {
@@ -202,7 +203,8 @@ public function createInstanceFor($constraintName)
     /**
      * Get the error context
      *
-     * @return string
+     * @return int
+     * @phpstan-return Validator::ERROR_DOCUMENT_VALIDATION|Validator::ERROR_SCHEMA_VALIDATION
      */
     public function getErrorContext()
     {
@@ -212,7 +214,8 @@ public function getErrorContext()
     /**
      * Set the error context
      *
-     * @param string $validationContext
+     * @param int $errorContext
+     * @phpstan-param Validator::ERROR_DOCUMENT_VALIDATION|Validator::ERROR_SCHEMA_VALIDATION $errorContext
      */
     public function setErrorContext($errorContext)
     {

src/JsonSchema/Constraints/TypeConstraint.php

@@ -81,11 +81,12 @@ public function check(&$value = null, $schema = null, JsonPointer $path = null,
      * of $isValid to true, if at least one $type mateches the type of $value or the value
      * passed as $isValid is already true.
      *
-     * @param mixed $value             Value to validate
-     * @param array $type              TypeConstraints to check against
-     * @param array $validTypesWording An array of wordings of the valid types of the array $type
-     * @param bool  $isValid           The current validation value
-     * @param $path
+     * @param mixed        $value             Value to validate
+     * @param array        $type              TypeConstraints to check against
+     * @param array        $validTypesWording An array of wordings of the valid types of the array $type
+     * @param bool         $isValid           The current validation value
+     * @param ?JsonPointer $path
+     * @param bool         $coerce
      */
     protected function validateTypesArray(&$value, array $type, &$validTypesWording, &$isValid, $path, $coerce = false)
     {
@@ -239,7 +240,7 @@ protected function validateType(&$value, $type, $coerce = false)
     /**
      * Converts a value to boolean. For example, "true" becomes true.
      *
-     * @param $value The value to convert to boolean
+     * @param mixed $value The value to convert to boolean
      *
      * @return bool|mixed
      */