Apply more strict type checking

phpDocumentor · Nov 3, 2024 · f985773 · f985773
1 parent db271d6
commit f985773
Show file tree

Hide file tree

Showing 11 changed files with 18 additions and 18 deletions.
diff --git a/Makefile b/Makefile
@@ -13,7 +13,7 @@ fix-code-style:
 .PHONY: static-code-analysis
 static-code-analysis: vendor ## Runs a static code analysis with phpstan/phpstan and vimeo/psalm
 	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/phpstan --configuration=phpstan.neon
-	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/psalm
+	docker run -it --rm -v${PWD}:/opt/project -w /opt/project php:7.4 vendor/bin/psalm.phar
 
 .PHONY: test
 test: test-unit ## Runs all test suites with phpunit/phpunit

diff --git a/src/DocBlock/ExampleFinder.php b/src/DocBlock/ExampleFinder.php
@@ -44,7 +44,7 @@ public function find(Example $example): string
         $filename = $example->getFilePath();
 
         $file = $this->getExampleFileContents($filename);
-        if (!$file) {
+        if ($file === null) {
             return sprintf('** File not found : %s **', $filename);
         }
 
@@ -112,7 +112,7 @@ private function getExampleFileContents(string $filename): ?array
             }
         }
 
-        if (!$normalizedPath) {
+        if ($normalizedPath === null) {
             if (is_readable($this->getExamplePathFromSource($filename))) {
                 $normalizedPath = $this->getExamplePathFromSource($filename);
             } elseif (is_readable($this->getExamplePathFromExampleDirectory($filename))) {
@@ -122,7 +122,7 @@ private function getExampleFileContents(string $filename): ?array
             }
         }
 
-        $lines = $normalizedPath && is_readable($normalizedPath) ? file($normalizedPath) : false;
+        $lines = $normalizedPath !== null && is_readable($normalizedPath) ? file($normalizedPath) : false;
 
         return $lines !== false ? $lines : null;
     }

diff --git a/src/DocBlock/Serializer.php b/src/DocBlock/Serializer.php
@@ -82,7 +82,7 @@ public function getDocComment(DocBlock $docblock): string
         $indent      = str_repeat($this->indentString, $this->indent);
         $firstIndent = $this->isFirstLineIndented ? $indent : '';
         // 3 === strlen(' * ')
-        $wrapLength = $this->lineLength ? $this->lineLength - strlen($indent) - 3 : null;
+        $wrapLength = $this->lineLength !== null ? $this->lineLength - strlen($indent) - 3 : null;
 
         $text = $this->removeTrailingSpaces(
             $indent,

diff --git a/src/DocBlock/StandardTagFactory.php b/src/DocBlock/StandardTagFactory.php
@@ -166,14 +166,14 @@ public function addParameter(string $name, $value): void
 
     public function addService(object $service, ?string $alias = null): void
     {
-        $this->serviceLocator[$alias ?: get_class($service)] = $service;
+        $this->serviceLocator[$alias ?? get_class($service)] = $service;
     }
 
     /** {@inheritDoc} */
     public function registerTagHandler(string $tagName, $handler): void
     {
         Assert::stringNotEmpty($tagName);
-        if (strpos($tagName, '\\') && $tagName[0] !== '\\') {
+        if (strpos($tagName, '\\') !== false && $tagName[0] !== '\\') {
             throw new InvalidArgumentException(
                 'A namespaced tag must have a leading backslash as it must be fully qualified'
             );

diff --git a/src/DocBlock/Tags/Deprecated.php b/src/DocBlock/Tags/Deprecated.php
@@ -62,7 +62,7 @@ public static function create(
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
     ): self {
-        if (empty($body)) {
+        if ($body === null || $body === '') {
             return new static();
         }
 

diff --git a/src/DocBlock/Tags/Param.php b/src/DocBlock/Tags/Param.php
@@ -160,7 +160,7 @@ public function __toString(): string
         }
 
         $variableName = '';
-        if ($this->variableName) {
+        if ($this->variableName !== null && $this->variableName !== '') {
             $variableName .= ($this->isReference ? '&' : '') . ($this->isVariadic ? '...' : '');
             $variableName .= '$' . $this->variableName;
         }

diff --git a/src/DocBlock/Tags/Property.php b/src/DocBlock/Tags/Property.php
@@ -111,13 +111,13 @@ public function getVariableName(): ?string
      */
     public function __toString(): string
     {
-        if ($this->description) {
+        if ($this->description !== null) {
             $description = $this->description->render();
         } else {
             $description = '';
         }
 
-        if ($this->variableName) {
+        if ($this->variableName !== null && $this->variableName !== '') {
             $variableName = '$' . $this->variableName;
         } else {
             $variableName = '';

diff --git a/src/DocBlock/Tags/PropertyRead.php b/src/DocBlock/Tags/PropertyRead.php
@@ -111,13 +111,13 @@ public function getVariableName(): ?string
      */
     public function __toString(): string
     {
-        if ($this->description) {
+        if ($this->description !== null) {
             $description = $this->description->render();
         } else {
             $description = '';
         }
 
-        if ($this->variableName) {
+        if ($this->variableName !== null && $this->variableName !== '') {
             $variableName = '$' . $this->variableName;
         } else {
             $variableName = '';

diff --git a/src/DocBlock/Tags/Since.php b/src/DocBlock/Tags/Since.php
@@ -59,7 +59,7 @@ public static function create(
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
     ): ?self {
-        if (empty($body)) {
+        if ($body === null || $body === '') {
             return new static();
         }
 
@@ -89,7 +89,7 @@ public function getVersion(): ?string
      */
     public function __toString(): string
     {
-        if ($this->description) {
+        if ($this->description !== null) {
             $description = $this->description->render();
         } else {
             $description = '';

diff --git a/src/DocBlock/Tags/Var_.php b/src/DocBlock/Tags/Var_.php
@@ -111,13 +111,13 @@ public function getVariableName(): ?string
      */
     public function __toString(): string
     {
-        if ($this->description) {
+        if ($this->description !== null) {
             $description = $this->description->render();
         } else {
             $description = '';
         }
 
-        if ($this->variableName) {
+        if ($this->variableName !== null && $this->variableName !== '') {
             $variableName = '$' . $this->variableName;
         } else {
             $variableName = '';

diff --git a/src/DocBlock/Tags/Version.php b/src/DocBlock/Tags/Version.php
@@ -59,7 +59,7 @@ public static function create(
         ?DescriptionFactory $descriptionFactory = null,
         ?TypeContext $context = null
     ): ?self {
-        if (empty($body)) {
+        if ($body === null || $body === '') {
             return new static();
         }