General: Fix missing phpstan data

SMillerDev · SMillerDev · commit 3bceb2fb86ef · 2021-02-11T23:25:13.000+01:00
diff --git a/src/PHPDraft/In/Tests/ApibFileParserTest.php b/src/PHPDraft/In/Tests/ApibFileParserTest.php
@@ -108,7 +108,8 @@ public function testParseBasic(): void
      *
      * @covers \PHPDraft\In\ApibFileParser::set_apib_content
      */
-    public function testSetContent(){
+    public function testSetContent(): void
+    {
         $this->class->set_apib_content('content');
         $this->assertEquals('content', $this->get_reflection_property_value('full_apib'));
     }
diff --git a/src/PHPDraft/Model/Elements/ObjectStructureElement.php b/src/PHPDraft/Model/Elements/ObjectStructureElement.php
@@ -18,13 +18,17 @@
 class ObjectStructureElement extends BasicStructureElement
 {
 
+    /**
+     * Object representation before parsing
+     * @var \stdClass
+     */
     private $object;
 
     /**
      * Unset object function.
      * @internal Only for tests
      */
-    public function __clearForTest()
+    public function __clearForTest(): void
     {
         $this->object = null;
     }
diff --git a/src/PHPDraft/Model/Elements/StructureElement.php b/src/PHPDraft/Model/Elements/StructureElement.php
@@ -17,7 +17,7 @@ interface StructureElement
     /**
      * Default data types.
      *
-     * @var array
+     * @var string[]
      */
     public const DEFAULTS = ['boolean', 'string', 'number', 'object', 'array', 'enum'];
 
diff --git a/src/PHPDraft/Model/Elements/Tests/ArrayStructureElementTest.php b/src/PHPDraft/Model/Elements/Tests/ArrayStructureElementTest.php
@@ -41,7 +41,7 @@ public function setUp(): void
      *
      * @covers \PHPDraft\Model\Elements\ArrayStructureElement::parse
      */
-    public function testSuccessfulParse($object, $expected)
+    public function testSuccessfulParse(string $object, ArrayStructureElement $expected): void
     {
         $dep = [];
         $obj = json_decode($object);
diff --git a/src/PHPDraft/Model/Elements/Tests/BasicStructureElementTest.php b/src/PHPDraft/Model/Elements/Tests/BasicStructureElementTest.php
@@ -53,9 +53,9 @@ public function testSetupCorrectly(): void
      * @dataProvider stringValueProvider
      *
      * @param mixed  $value        Value to set to the class
-     * @param string $string_value Expected string representation
+     * @param mixed $string_value Expected string representation
      */
-    public function testStringValue($value, $string_value)
+    public function testStringValue($value, $string_value): void
     {
         $this->set_reflection_property_value('value', $value);
 
@@ -119,7 +119,7 @@ public function testParseCommonDeps(): void
      * @param mixed                 $value          Value to set to the class
      * @param BasicStructureElement $expected_value Expected string representation
      */
-    public function testParseCommon($value, $expected_value)
+    public function testParseCommon($value, BasicStructureElement $expected_value): void
     {
         $dep = [];
         $method = $this->reflection->getMethod('parse_common');
diff --git a/src/PHPDraft/Model/Elements/Tests/ElementStructureElementTest.php b/src/PHPDraft/Model/Elements/Tests/ElementStructureElementTest.php
@@ -34,7 +34,7 @@ public function tearDown(): void
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::parse
      */
-    public function testParse()
+    public function testParse(): void
     {
         $json = '{"element": "Cow", "content": "stuff", "meta": {"description": {"content": "desc"}}}';
         $dep  = [];
@@ -49,15 +49,15 @@ public function testParse()
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::string_value
      */
-    public function testStringValue()
+    public function testStringValue(): void
     {
         $this->assertSame('<li class="list-group-item mdl-list__item"><a class="code" title="" href="#object-"></a></li>', $this->class->string_value());
     }
 
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::__toString
      */
-    public function testToString()
+    public function testToString(): void
     {
         $this->set_reflection_property_value('type', 'string');
 
@@ -67,7 +67,7 @@ public function testToString()
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::__toString
      */
-    public function testToStringCustomType()
+    public function testToStringCustomType(): void
     {
         $this->set_reflection_property_value('type', 'Cow');
 
@@ -77,7 +77,7 @@ public function testToStringCustomType()
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::__toString
      */
-    public function testToStringDescription()
+    public function testToStringDescription(): void
     {
         $this->set_reflection_property_value('type', 'Cow');
         $this->set_reflection_property_value('description', 'Something');
@@ -88,7 +88,7 @@ public function testToStringDescription()
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::__toString
      */
-    public function testToStringValue()
+    public function testToStringValue(): void
     {
         $this->set_reflection_property_value('type', 'Cow');
         $this->set_reflection_property_value('value', 'stuff');
@@ -99,7 +99,7 @@ public function testToStringValue()
     /**
      * @covers  \PHPDraft\Model\Elements\ElementStructureElement::__toString
      */
-    public function testToStringDescriptionAndValue()
+    public function testToStringDescriptionAndValue(): void
     {
         $this->set_reflection_property_value('type', 'Cow');
         $this->set_reflection_property_value('value', 'stuff');
diff --git a/src/PHPDraft/Model/Elements/Tests/EnumStructureElementTest.php b/src/PHPDraft/Model/Elements/Tests/EnumStructureElementTest.php
@@ -120,7 +120,7 @@ public function testToStringWithComplexArray(): void
      *
      * @covers \PHPDraft\Model\Elements\EnumStructureElement::parse
      */
-    public function testSuccesfulParse($object, $expected)
+    public function testSuccesfulParse(string $object, EnumStructureElement $expected): void
     {
         $dep = [];
         $res = $this->class->parse(json_decode($object), $dep);
diff --git a/src/PHPDraft/Model/Elements/Tests/ObjectStructureElementTest.php b/src/PHPDraft/Model/Elements/Tests/ObjectStructureElementTest.php
@@ -58,7 +58,7 @@ public function testNewInstance(): void
      *
      * @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
      */
-    public function testSuccesfulParse($object, $expected)
+    public function testSuccesfulParse(string $object, ObjectStructureElement $expected): void
     {
         $dep = [];
         $res = $this->class->parse(json_decode($object), $dep);
diff --git a/src/PHPDraft/Model/Elements/Tests/RequestBodyElementTest.php b/src/PHPDraft/Model/Elements/Tests/RequestBodyElementTest.php
@@ -112,7 +112,7 @@ public function testPrintJsonArray(): void
      *
      * @covers       \PHPDraft\Model\Elements\ObjectStructureElement::parse
      */
-    public function testSuccessfulParse($object, $expected)
+    public function testSuccessfulParse(string $object, ObjectStructureElement $expected): void
     {
         $dep = [];
         $res = $this->class->parse(json_decode($object), $dep);
diff --git a/src/PHPDraft/Out/BaseTemplateRenderer.php b/src/PHPDraft/Out/BaseTemplateRenderer.php
@@ -26,13 +26,13 @@ abstract class BaseTemplateRenderer
     /**
      * CSS Files to load.
      *
-     * @var array
+     * @var string[]
      */
     public $css = [];
     /**
      * JS Files to load.
      *
-     * @var array
+     * @var string[]
      */
     public $js = [];
     /**
@@ -56,7 +56,7 @@ abstract class BaseTemplateRenderer
     /**
      * The base data of the API.
      *
-     * @var array
+     * @var array<mixed>
      */
     protected $base_data;
     /**
diff --git a/src/PHPDraft/Out/Tests/TemplateRendererTest.php b/src/PHPDraft/Out/Tests/TemplateRendererTest.php
@@ -58,6 +58,7 @@ public function testStripSpaces(): void
 
     /**
      * Provide HTTP status codes
+     * @return array<int, array<int, int|string>>
      */
     public function responseStatusProvider(): array
     {
@@ -90,6 +91,7 @@ public function testResponseStatus($code, $text): void
 
     /**
      * Provide HTTP methods
+     * @return array<int, array<int, string>>
      */
     public function requestMethodProvider(): array
     {
@@ -115,14 +117,14 @@ public function requestMethodProvider(): array
      *
      * @dataProvider requestMethodProvider
      *
-     * @param int    $code HTTP Method
+     * @param string $method HTTP Method
      * @param string $text Class to return
      *
      * @covers \PHPDraft\Out\TemplateRenderer::get_method_icon
      */
-    public function testRequestMethod($code, $text): void
+    public function testRequestMethod(string $method, string $text): void
     {
-        $return = TemplateRenderer::get_method_icon($code);
+        $return = TemplateRenderer::get_method_icon($method);
         $this->assertEquals($text, $return);
     }
 
diff --git a/src/PHPDraft/Out/TwigFactory.php b/src/PHPDraft/Out/TwigFactory.php
@@ -72,7 +72,7 @@ public static function get(LoaderInterface $loader): Environment {
         }));
 
         $twig->addRuntimeLoader(new class implements RuntimeLoaderInterface {
-            public function load($class) {
+            public function load(string $class) {
                 if (MarkdownRuntime::class === $class) {
                     return new MarkdownRuntime(new DefaultMarkdown());
                 }
diff --git a/src/PHPDraft/Parse/DrafterAPI.php b/src/PHPDraft/Parse/DrafterAPI.php
@@ -53,7 +53,7 @@ protected function parse(): void
      *
      * @param string $message API blueprint to parse
      *
-     * @return false|resource
+     * @return false|resource|\CurlHandle
      */
     public static function curl_init_drafter(string $message)
     {
diff --git a/src/PHPDraft/Parse/Tests/BaseHtmlGeneratorTest.php b/src/PHPDraft/Parse/Tests/BaseHtmlGeneratorTest.php
@@ -35,7 +35,7 @@ public function tearDown(): void
     /**
      * * @covers  \PHPDraft\Parse\BaseHtmlGenerator::init
      */
-    public function testInit()
+    public function testInit(): void
     {
         $data = json_decode(file_get_contents(TEST_STATICS . '/drafter/json/index.json'));
         $init = $this->class->init($data);
diff --git a/src/PHPDraft/Parse/Tests/HtmlGeneratorTest.php b/src/PHPDraft/Parse/Tests/HtmlGeneratorTest.php
@@ -51,13 +51,15 @@ public function setUp(): void
      */
     public function tearDown(): void
     {
-        uopz_undefine('ID_STATIC');
+        $this->constant_undefine('ID_STATIC');
         unset($this->class);
         unset($this->reflection);
     }
 
     /**
      * Tests if the constructor sets the property correctly
+     *
+     * @requires ext-uopz
      */
     public function testSetupCorrectly(): void
     {
@@ -68,6 +70,7 @@ public function testSetupCorrectly(): void
 
     /**
      * Tests if the constructor sets the property correctly
+     * @requires ext-uopz
      */
     public function testGetHTML(): void
     {
@@ -77,6 +80,7 @@ public function testGetHTML(): void
 
     /**
      * Tests if the constructor sets the property correctly
+     * @requires ext-uopz
      */
     public function testGetHTMLMaterial(): void
     {
@@ -86,6 +90,7 @@ public function testGetHTMLMaterial(): void
 
     /**
      * Tests if the constructor sets the property correctly
+     * @requires ext-uopz
      */
     public function testGetHTMLAdvanced(): void
     {
diff --git a/src/PHPDraft/Parse/Tests/ParserFactoryTest.php b/src/PHPDraft/Parse/Tests/ParserFactoryTest.php
@@ -15,7 +15,7 @@ class ParserFactoryTest extends LunrBaseTest
     /**
      * @covers \PHPDraft\Parse\ParserFactory::getDrafter
      */
-    public function testGetDrafter()
+    public function testGetDrafter(): void
     {
         $this->mock_method(['\PHPDraft\Parse\Drafter', 'available'], function () {
             return true;
@@ -29,7 +29,7 @@ public function testGetDrafter()
     /**
      * @covers \PHPDraft\Parse\ParserFactory::getDrafter
      */
-    public function testGetDrafterAPI()
+    public function testGetDrafterAPI(): void
     {
         $this->mock_method(['\PHPDraft\Parse\Drafter', 'available'], function () {
             return false;
@@ -47,7 +47,7 @@ public function testGetDrafterAPI()
     /**
      * @covers \PHPDraft\Parse\ParserFactory::getDrafter
      */
-    public function testGetDrafterFails()
+    public function testGetDrafterFails(): void
     {
         $this->expectException('\PHPDraft\Parse\ResourceException');
         $this->expectExceptionMessage('Couldn\'t get an APIB parser');
@@ -67,7 +67,7 @@ public function testGetDrafterFails()
     /**
      * @covers \PHPDraft\Parse\ParserFactory::getJson
      */
-    public function testGetJson()
+    public function testGetJson(): void
     {
         $this->mock_method(['\PHPDraft\Parse\Drafter', 'available'], function () {
             return false;
@@ -85,7 +85,7 @@ public function testGetJson()
     /**
      * @covers \PHPDraft\Parse\ParserFactory::getJson
      */
-    public function testGetJsonFails()
+    public function testGetJsonFails(): void
     {
         $this->expectException('\PHPDraft\Parse\ResourceException');
         $this->expectExceptionMessage('Couldn\'t get a JSON parser');

Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,8 @@ public function testParseBasic(): void`
`108`	`108`	`*`
`109`	`109`	`* @covers \PHPDraft\In\ApibFileParser::set_apib_content`
`110`	`110`	`*/`
`111`		`- public function testSetContent(){`
	`111`	`+ public function testSetContent(): void`
	`112`	`+ {`
`112`	`113`	`$this->class->set_apib_content('content');`
`113`	`114`	`$this->assertEquals('content', $this->get_reflection_property_value('full_apib'));`
`114`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,13 +18,17 @@`
`18`	`18`	`class ObjectStructureElement extends BasicStructureElement`
`19`	`19`	`{`
`20`	`20`
	`21`	`+ /**`
	`22`	`+ * Object representation before parsing`
	`23`	`+ * @var \stdClass`
	`24`	`+ */`
`21`	`25`	`private $object;`
`22`	`26`
`23`	`27`	`/**`
`24`	`28`	`* Unset object function.`
`25`	`29`	`* @internal Only for tests`
`26`	`30`	`*/`
`27`		`- public function __clearForTest()`
	`31`	`+ public function __clearForTest(): void`
`28`	`32`	`{`
`29`	`33`	`$this->object = null;`
`30`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ interface StructureElement`
`17`	`17`	`/**`
`18`	`18`	`* Default data types.`
`19`	`19`	`*`
`20`		`- * @var array`
	`20`	`+ * @var string[]`
`21`	`21`	`*/`
`22`	`22`	`public const DEFAULTS = ['boolean', 'string', 'number', 'object', 'array', 'enum'];`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function setUp(): void`
`41`	`41`	`*`
`42`	`42`	`* @covers \PHPDraft\Model\Elements\ArrayStructureElement::parse`
`43`	`43`	`*/`
`44`		`- public function testSuccessfulParse($object, $expected)`
	`44`	`+ public function testSuccessfulParse(string $object, ArrayStructureElement $expected): void`
`45`	`45`	`{`
`46`	`46`	`$dep = [];`
`47`	`47`	`$obj = json_decode($object);`
Original file line number	Diff line number	Diff line change
`@@ -53,9 +53,9 @@ public function testSetupCorrectly(): void`
`53`	`53`	`* @dataProvider stringValueProvider`
`54`	`54`	`*`
`55`	`55`	`* @param mixed $value Value to set to the class`
`56`		`- * @param string $string_value Expected string representation`
	`56`	`+ * @param mixed $string_value Expected string representation`
`57`	`57`	`*/`
`58`		`- public function testStringValue($value, $string_value)`
	`58`	`+ public function testStringValue($value, $string_value): void`
`59`	`59`	`{`
`60`	`60`	`$this->set_reflection_property_value('value', $value);`
`61`	`61`
`@@ -119,7 +119,7 @@ public function testParseCommonDeps(): void`
`119`	`119`	`* @param mixed $value Value to set to the class`
`120`	`120`	`* @param BasicStructureElement $expected_value Expected string representation`
`121`	`121`	`*/`
`122`		`- public function testParseCommon($value, $expected_value)`
	`122`	`+ public function testParseCommon($value, BasicStructureElement $expected_value): void`
`123`	`123`	`{`
`124`	`124`	`$dep = [];`
`125`	`125`	`$method = $this->reflection->getMethod('parse_common');`
Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ public function testToStringWithComplexArray(): void`
`120`	`120`	`*`
`121`	`121`	`* @covers \PHPDraft\Model\Elements\EnumStructureElement::parse`
`122`	`122`	`*/`
`123`		`- public function testSuccesfulParse($object, $expected)`
	`123`	`+ public function testSuccesfulParse(string $object, EnumStructureElement $expected): void`
`124`	`124`	`{`
`125`	`125`	`$dep = [];`
`126`	`126`	`$res = $this->class->parse(json_decode($object), $dep);`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function testNewInstance(): void`
`58`	`58`	`*`
`59`	`59`	`* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse`
`60`	`60`	`*/`
`61`		`- public function testSuccesfulParse($object, $expected)`
	`61`	`+ public function testSuccesfulParse(string $object, ObjectStructureElement $expected): void`
`62`	`62`	`{`
`63`	`63`	`$dep = [];`
`64`	`64`	`$res = $this->class->parse(json_decode($object), $dep);`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public function testPrintJsonArray(): void`
`112`	`112`	`*`
`113`	`113`	`* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse`
`114`	`114`	`*/`
`115`		`- public function testSuccessfulParse($object, $expected)`
	`115`	`+ public function testSuccessfulParse(string $object, ObjectStructureElement $expected): void`
`116`	`116`	`{`
`117`	`117`	`$dep = [];`
`118`	`118`	`$res = $this->class->parse(json_decode($object), $dep);`