improved types for phpstan

cebe · cebe · commit 1be17d69adac · 2020-12-15T21:01:05.000+01:00
diff --git a/src/Reader.php b/src/Reader.php
@@ -85,7 +85,9 @@ public static function readFromJsonFile(string $fileName, string $baseType = Ope
             if (is_string($resolveReferences)) {
                 $context->mode = $resolveReferences;
             }
-            $spec->setDocumentContext($spec, new JsonPointer(''));
+            if ($spec instanceof DocumentContextInterface) {
+                $spec->setDocumentContext($spec, new JsonPointer(''));
+            }
             $spec->resolveReferences();
         }
         return $spec;
@@ -126,7 +128,9 @@ public static function readFromYamlFile(string $fileName, string $baseType = Ope
             if (is_string($resolveReferences)) {
                 $context->mode = $resolveReferences;
             }
-            $spec->setDocumentContext($spec, new JsonPointer(''));
+            if ($spec instanceof DocumentContextInterface) {
+                $spec->setDocumentContext($spec, new JsonPointer(''));
+            }
             $spec->resolveReferences();
         }
         return $spec;
diff --git a/src/ReferenceContext.php b/src/ReferenceContext.php
@@ -238,7 +238,7 @@ public function fetchReferencedFile($uri)
      * @param JsonPointer $pointer
      * @param array $data
      * @param string|null $toType
-     * @return SpecObjectInterface|array
+     * @return SpecObjectInterface|array|null
      */
     public function resolveReferenceData($uri, JsonPointer $pointer, $data, $toType)
     {
@@ -255,7 +255,6 @@ public function resolveReferenceData($uri, JsonPointer $pointer, $data, $toType)
 
         // transitive reference
         if (isset($referencedData['$ref'])) {
-            /** @var Reference $referencedObject */
             return new Reference($referencedData, $toType);
         } else {
             /** @var SpecObjectInterface|array $referencedObject */
diff --git a/src/spec/Callback.php b/src/spec/Callback.php
@@ -22,12 +22,25 @@
  */
 class Callback implements SpecObjectInterface, DocumentContextInterface
 {
+    /**
+     * @var string|null
+     */
     private $_url;
+    /**
+     * @var PathItem
+     */
     private $_pathItem;
-
+    /**
+     * @var array
+     */
     private $_errors = [];
-
+    /**
+     * @var SpecObjectInterface|null
+     */
     private $_baseDocument;
+    /**
+     * @var JsonPointer|null
+     */
     private $_jsonPointer;
 
 
diff --git a/src/spec/Paths.php b/src/spec/Paths.php
@@ -34,10 +34,17 @@ class Paths implements SpecObjectInterface, DocumentContextInterface, ArrayAcces
      * @var (PathItem|null)[]
      */
     private $_paths = [];
-
+    /**
+     * @var array
+     */
     private $_errors = [];
-
+    /**
+     * @var SpecObjectInterface|null
+     */
     private $_baseDocument;
+    /**
+     * @var JsonPointer|null
+     */
     private $_jsonPointer;
 
 
diff --git a/src/spec/Reference.php b/src/spec/Reference.php
@@ -29,14 +29,33 @@
  */
 class Reference implements SpecObjectInterface, DocumentContextInterface
 {
+    /**
+     * @var string
+     */
     private $_to;
+    /**
+     * @var string
+     */
     private $_ref;
+    /**
+     * @var JsonReference|null
+     */
     private $_jsonReference;
+    /**
+     * @var ReferenceContext
+     */
     private $_context;
-
+    /**
+     * @var SpecObjectInterface|null
+     */
     private $_baseDocument;
+    /**
+     * @var JsonPointer|null
+     */
     private $_jsonPointer;
-
+    /**
+     * @var array
+     */
     private $_errors = [];
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,9 @@ public static function readFromJsonFile(string $fileName, string $baseType = Ope`
`85`	`85`	`if (is_string($resolveReferences)) {`
`86`	`86`	`$context->mode = $resolveReferences;`
`87`	`87`	`}`
`88`		`- $spec->setDocumentContext($spec, new JsonPointer(''));`
	`88`	`+ if ($spec instanceof DocumentContextInterface) {`
	`89`	`+ $spec->setDocumentContext($spec, new JsonPointer(''));`
	`90`	`+ }`
`89`	`91`	`$spec->resolveReferences();`
`90`	`92`	`}`
`91`	`93`	`return $spec;`
`@@ -126,7 +128,9 @@ public static function readFromYamlFile(string $fileName, string $baseType = Ope`
`126`	`128`	`if (is_string($resolveReferences)) {`
`127`	`129`	`$context->mode = $resolveReferences;`
`128`	`130`	`}`
`129`		`- $spec->setDocumentContext($spec, new JsonPointer(''));`
	`131`	`+ if ($spec instanceof DocumentContextInterface) {`
	`132`	`+ $spec->setDocumentContext($spec, new JsonPointer(''));`
	`133`	`+ }`
`130`	`134`	`$spec->resolveReferences();`
`131`	`135`	`}`
`132`	`136`	`return $spec;`