Fixed deprecated null parameter in trim

DocScanner may raise a Deprecated error with PHP 8.1 if shortDescription is used before initialization, the default value being null Signed-off-by: Massimiliano Torromeo <[email protected]>
researchgate · Dec 14, 2021 · 9e537d2 · 9e537d2
1 parent c99ef8e
commit 9e537d2
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -2,6 +2,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
+         convertDeprecationsToExceptions="true"
          colors="true">
     <testsuites>
         <testsuite name="laminas-code Test Suite">

diff --git a/src/Scanner/DocBlockScanner.php b/src/Scanner/DocBlockScanner.php
@@ -25,7 +25,7 @@ class DocBlockScanner
     protected $docComment;
 
     /** @var string */
-    protected $shortDescription;
+    protected $shortDescription = '';
 
     /** @var string */
     protected $longDescription = '';

diff --git a/test/Scanner/DocBlockScannerTest.php b/test/Scanner/DocBlockScannerTest.php
@@ -51,4 +51,11 @@ public function testDocBlockScannerDescriptions()
         self::assertEquals('Short Description', $tokenScanner->getShortDescription());
         self::assertEquals('Long Description continued in the second line', $tokenScanner->getLongDescription());
     }
+
+    public function testInvalidDocBlock()
+    {
+        $docComment   = '/**';
+        $tokenScanner = new DocBlockScanner($docComment);
+        self::assertEquals('', $tokenScanner->getShortDescription());
+    }
 }