Fix phpstan errors

phpDocumentor · Jan 21, 2019 · 81a7a60 · 81a7a60
1 parent 870f5eb
commit 81a7a60
Show file tree

Hide file tree

Showing 24 changed files with 74 additions and 85 deletions.
diff --git a/composer.json b/composer.json
@@ -23,6 +23,7 @@
     },
     "require": {
         "php": ">=7.1.3",
+        "ext-dom": "*",
         "ext-iconv": "*",
         "ext-json": "*",
         "erusev/parsedown": "~1.0",

diff --git a/composer.lock b/composer.lock
diff --git a/docker/phpstan/Dockerfile b/docker/phpstan/Dockerfile
@@ -1,4 +1,4 @@
-FROM phpstan/phpstan:phar
+FROM phpstan/phpstan:0.11
 RUN apk add --no-cache \
     php7-intl \
     php7-xsl \

diff --git a/phpstan.neon b/phpstan.neon
@@ -3,7 +3,6 @@ parameters:
     - '#Constructor of class phpDocumentor\\Plugin\\Twig\\Extension has an unused parameter \$transformation#'
     - '#Call to an undefined method League\\Flysystem\\Filesystem::find()#'
     - '#Call to an undefined method Zend\\Cache\\Storage\\Adapter\\AdapterOptions::setCacheDir()#'
-    - '#PHPDoc tag [a-zA-Z0-9@]+ has invalid value ([a-zA-Z0-9`\.@\s\(\)\{]+): Unexpected token "`", expected TOKEN_IDENTIFIER at offset#'
     - '#Access to an undefined property phpDocumentor\\Descriptor\\Collection::\$[a-z]+#'
   excludes_analyse:
    #test data

diff --git a/src/phpDocumentor/Application/Stage/Transform.php b/src/phpDocumentor/Application/Stage/Transform.php
@@ -24,6 +24,7 @@
 use phpDocumentor\Transformer\Event\PreTransformEvent;
 use phpDocumentor\Transformer\Event\WriterInitializationEvent;
 use phpDocumentor\Transformer\Transformer;
+use phpDocumentor\Transformer\Writer\WriterAbstract;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Stopwatch\Stopwatch;
@@ -181,15 +182,19 @@ function (PreTransformEvent $event) {
         Dispatcher::getInstance()->addListener(
             Transformer::EVENT_PRE_INITIALIZATION,
             function (WriterInitializationEvent $event) {
-                $this->logger->info('  Initialize writer "' . get_class($event->getWriter()) . '"');
+                if ($event->getWriter() instanceof WriterAbstract) {
+                    $this->logger->info('  Initialize writer "' . get_class($event->getWriter()) . '"');
+                }
             }
         );
         Dispatcher::getInstance()->addListener(
             Transformer::EVENT_PRE_TRANSFORMATION,
             function (PreTransformationEvent $event) {
-                $this->logger->info(
-                    '  Execute transformation using writer "' . $event->getTransformation()->getWriter() . '"'
-                );
+                if ($event->getTransformation()->getWriter() instanceof WriterAbstract) {
+                    $this->logger->info(
+                        '  Execute transformation using writer "' . $event->getTransformation()->getWriter() . '"'
+                    );
+                }
             }
         );
     }

diff --git a/src/phpDocumentor/Descriptor/Builder/Reflector/ClassAssembler.php b/src/phpDocumentor/Descriptor/Builder/Reflector/ClassAssembler.php
@@ -17,6 +17,9 @@
 
 use phpDocumentor\Descriptor\ClassDescriptor;
 use phpDocumentor\Descriptor\Collection;
+use phpDocumentor\Descriptor\ConstantDescriptor;
+use phpDocumentor\Descriptor\MethodDescriptor;
+use phpDocumentor\Descriptor\PropertyDescriptor;
 use phpDocumentor\Reflection\Php\Class_;
 use phpDocumentor\Reflection\Php\Constant;
 use phpDocumentor\Reflection\Php\Method;
@@ -72,7 +75,7 @@ protected function addConstants(array $constants, ClassDescriptor $classDescript
     {
         foreach ($constants as $constant) {
             $constantDescriptor = $this->getBuilder()->buildDescriptor($constant);
-            if ($constantDescriptor) {
+            if ($constantDescriptor instanceof ConstantDescriptor) {
                 $constantDescriptor->setParent($classDescriptor);
                 $classDescriptor->getConstants()->set($constantDescriptor->getName(), $constantDescriptor);
             }
@@ -88,7 +91,7 @@ protected function addProperties(array $properties, ClassDescriptor $classDescri
     {
         foreach ($properties as $property) {
             $propertyDescriptor = $this->getBuilder()->buildDescriptor($property);
-            if ($propertyDescriptor) {
+            if ($propertyDescriptor instanceof PropertyDescriptor) {
                 $propertyDescriptor->setParent($classDescriptor);
                 $classDescriptor->getProperties()->set($propertyDescriptor->getName(), $propertyDescriptor);
             }
@@ -104,7 +107,7 @@ protected function addMethods(array $methods, ClassDescriptor $classDescriptor):
     {
         foreach ($methods as $method) {
             $methodDescriptor = $this->getBuilder()->buildDescriptor($method);
-            if ($methodDescriptor) {
+            if ($methodDescriptor instanceof MethodDescriptor) {
                 $methodDescriptor->setParent($classDescriptor);
                 $classDescriptor->getMethods()->set($methodDescriptor->getName(), $methodDescriptor);
             }

diff --git a/src/phpDocumentor/Descriptor/Builder/Reflector/InterfaceAssembler.php b/src/phpDocumentor/Descriptor/Builder/Reflector/InterfaceAssembler.php
@@ -15,7 +15,9 @@
 
 namespace phpDocumentor\Descriptor\Builder\Reflector;
 
+use phpDocumentor\Descriptor\ConstantDescriptor;
 use phpDocumentor\Descriptor\InterfaceDescriptor;
+use phpDocumentor\Descriptor\MethodDescriptor;
 use phpDocumentor\Reflection\Php\Constant;
 use phpDocumentor\Reflection\Php\Interface_;
 use phpDocumentor\Reflection\Php\Method;
@@ -64,7 +66,7 @@ protected function addConstants(array $constants, InterfaceDescriptor $interface
     {
         foreach ($constants as $constant) {
             $constantDescriptor = $this->getBuilder()->buildDescriptor($constant);
-            if ($constantDescriptor) {
+            if ($constantDescriptor instanceof ConstantDescriptor) {
                 $constantDescriptor->setParent($interfaceDescriptor);
                 $interfaceDescriptor->getConstants()->set($constantDescriptor->getName(), $constantDescriptor);
             }
@@ -80,7 +82,7 @@ protected function addMethods(array $methods, InterfaceDescriptor $interfaceDesc
     {
         foreach ($methods as $method) {
             $methodDescriptor = $this->getBuilder()->buildDescriptor($method);
-            if ($methodDescriptor) {
+            if ($methodDescriptor instanceof MethodDescriptor) {
                 $methodDescriptor->setParent($interfaceDescriptor);
                 $interfaceDescriptor->getMethods()->set($methodDescriptor->getName(), $methodDescriptor);
             }

diff --git a/src/phpDocumentor/Descriptor/Builder/Reflector/TraitAssembler.php b/src/phpDocumentor/Descriptor/Builder/Reflector/TraitAssembler.php
@@ -15,6 +15,8 @@
 
 namespace phpDocumentor\Descriptor\Builder\Reflector;
 
+use phpDocumentor\Descriptor\MethodDescriptor;
+use phpDocumentor\Descriptor\PropertyDescriptor;
 use phpDocumentor\Descriptor\TraitDescriptor;
 use phpDocumentor\Reflection\Php\Method;
 use phpDocumentor\Reflection\Php\Property;
@@ -63,7 +65,7 @@ protected function addProperties(array $properties, TraitDescriptor $traitDescri
     {
         foreach ($properties as $property) {
             $propertyDescriptor = $this->getBuilder()->buildDescriptor($property);
-            if ($propertyDescriptor) {
+            if ($propertyDescriptor instanceof PropertyDescriptor) {
                 $propertyDescriptor->setParent($traitDescriptor);
                 $traitDescriptor->getProperties()->set($propertyDescriptor->getName(), $propertyDescriptor);
             }
@@ -79,7 +81,7 @@ protected function addMethods(array $methods, TraitDescriptor $traitDescriptor):
     {
         foreach ($methods as $method) {
             $methodDescriptor = $this->getBuilder()->buildDescriptor($method);
-            if ($methodDescriptor) {
+            if ($methodDescriptor instanceof MethodDescriptor) {
                 $methodDescriptor->setParent($traitDescriptor);
                 $traitDescriptor->getMethods()->set($methodDescriptor->getName(), $methodDescriptor);
             }

diff --git a/src/phpDocumentor/Descriptor/DescriptorAbstract.php b/src/phpDocumentor/Descriptor/DescriptorAbstract.php
@@ -418,7 +418,7 @@ public function __call($name, $arguments)
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return (string) $this->getFullyQualifiedStructuralElementName();
     }

diff --git a/src/phpDocumentor/Descriptor/InterfaceDescriptor.php b/src/phpDocumentor/Descriptor/InterfaceDescriptor.php
@@ -42,15 +42,15 @@ public function __construct()
     }
 
     /**
-     * {@inheritDoc}
+     * @param Collection $parents
      */
     public function setParent($parents)
     {
         $this->parents = $parents;
     }
 
     /**
-     * {@inheritDoc}
+     * @return Collection
      */
     public function getParent()
     {

diff --git a/src/phpDocumentor/Descriptor/Interfaces/TypeInterface.php b/src/phpDocumentor/Descriptor/Interfaces/TypeInterface.php
@@ -17,4 +17,5 @@
 
 interface TypeInterface
 {
+    public function __toString(): string;
 }
diff --git a/src/phpDocumentor/Descriptor/Type/BooleanDescriptor.php b/src/phpDocumentor/Descriptor/Type/BooleanDescriptor.php
@@ -37,7 +37,7 @@ public function getName()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getName();
     }

diff --git a/src/phpDocumentor/Descriptor/Type/CollectionDescriptor.php b/src/phpDocumentor/Descriptor/Type/CollectionDescriptor.php
@@ -123,9 +123,9 @@ public function getKeyTypes()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
-        $name = $this->getName();
+        $name = (string) $this->getName();
 
         $keyTypes = [];
         foreach ($this->getKeyTypes() as $type) {

diff --git a/src/phpDocumentor/Descriptor/Type/FloatDescriptor.php b/src/phpDocumentor/Descriptor/Type/FloatDescriptor.php
@@ -34,7 +34,7 @@ public function getName()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getName();
     }

diff --git a/src/phpDocumentor/Descriptor/Type/IntegerDescriptor.php b/src/phpDocumentor/Descriptor/Type/IntegerDescriptor.php
@@ -34,7 +34,7 @@ public function getName()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getName();
     }

diff --git a/src/phpDocumentor/Descriptor/Type/StringDescriptor.php b/src/phpDocumentor/Descriptor/Type/StringDescriptor.php
@@ -34,7 +34,7 @@ public function getName()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getName();
     }

diff --git a/src/phpDocumentor/Descriptor/Type/UnknownTypeDescriptor.php b/src/phpDocumentor/Descriptor/Type/UnknownTypeDescriptor.php
@@ -53,7 +53,7 @@ public function getName()
      *
      * @return string
      */
-    public function __toString()
+    public function __toString(): string
     {
         return $this->getName();
     }

diff --git a/src/phpDocumentor/Plugin/Core/ServiceProvider.php b/src/phpDocumentor/Plugin/Core/ServiceProvider.php
@@ -57,14 +57,18 @@ private function registerWriters(Application $app)
         $writerCollection = $this->getWriterCollection($app);
 
         $writerCollection['FileIo'] = new Writer\FileIo();
-        $writerCollection['checkstyle'] = new Writer\Checkstyle();
         $writerCollection['sourcecode'] = new Writer\Sourcecode();
         $writerCollection['statistics'] = new Writer\Statistics();
-        $writerCollection['xml'] = new Writer\Xml($app['transformer.routing.standard']);
         $writerCollection['xsl'] = new Writer\Xsl($app['monolog']);
 
-        $writerCollection['checkstyle']->setTranslator($this->getTranslator($app));
-        $writerCollection['xml']->setTranslator($this->getTranslator($app));
+        $checkstyleWriter = new Writer\Checkstyle();
+        $checkstyleWriter->setTranslator($this->getTranslator($app));
+
+        $xmlWriter =  new Writer\Xml($app['transformer.routing.standard']);
+        $xmlWriter->setTranslator($this->getTranslator($app));
+
+        $writerCollection['checkstyle'] = $checkstyleWriter;
+        $writerCollection['xml'] = $xmlWriter;
     }
 
     /**

diff --git a/src/phpDocumentor/Plugin/Twig/ServiceProvider.php b/src/phpDocumentor/Plugin/Twig/ServiceProvider.php
@@ -42,7 +42,9 @@ public function register(Container $app): void
 
         /** @var Collection $writerCollection */
         $writerCollection = $app['transformer.writer.collection'];
-        $writerCollection['twig'] = new Writer\Twig($app[\Twig\Environment::class]);
-        $writerCollection['twig']->setTranslator($translator);
+        $twigWriter = new Writer\Twig($app[\Twig\Environment::class]);
+        $twigWriter->setTranslator($translator);
+
+        $writerCollection['twig'] = $twigWriter;
     }
 }
diff --git a/src/phpDocumentor/Transformer/Event/PostTransformationEvent.php b/src/phpDocumentor/Transformer/Event/PostTransformationEvent.php
@@ -15,13 +15,15 @@
 
 namespace phpDocumentor\Transformer\Event;
 
+use phpDocumentor\Event\EventAbstract;
+
 /**
  * Event that happens after each individual transformation.
  *
  * @author    Mike van Riel <mike.vanriel@naenius.com>
  * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  */
-class PostTransformationEvent extends PreTransformationEvent
+class PostTransformationEvent extends EventAbstract
 {
 }
diff --git a/src/phpDocumentor/Transformer/Event/PreTransformationEvent.php b/src/phpDocumentor/Transformer/Event/PreTransformationEvent.php
@@ -24,39 +24,22 @@
  */
 class PreTransformationEvent extends EventAbstract
 {
-    /** @var \DOMDocument remembers the XML-based AST so that it can be used from the listener */
-    protected $source;
-
     /** @var Transformation */
     protected $transformation;
 
-    /**
-     * Returns the Abstract Syntax Tree as DOMDocument.
-     */
-    public function getSource(): ?\DOMDocument
+    public function __construct($subject, Transformation $transformation)
     {
-        return $this->source;
+        parent::__construct($subject);
+        $this->transformation = $transformation;
     }
 
-    /**
-     * Sets the Abstract Syntax Tree as DOMDocument.
-     */
-    public function setSource(\DOMDocument $source): self
+    public static function create($subject, Transformation $transformation)
     {
-        $this->source = $source;
-
-        return $this;
+        return new static($subject, $transformation);
     }
 
-    public function getTransformation(): ?Transformation
+    public function getTransformation(): Transformation
     {
         return $this->transformation;
     }
-
-    public function setTransformation(Transformation $transformation): self
-    {
-        $this->transformation = $transformation;
-
-        return $this;
-    }
 }
diff --git a/src/phpDocumentor/Transformer/Transformer.php b/src/phpDocumentor/Transformer/Transformer.php
@@ -279,8 +279,7 @@ private function applyTransformationToProject(Transformation $transformation, Pr
         );
 
         /** @var PreTransformationEvent $preTransformationEvent */
-        $preTransformationEvent = PreTransformationEvent::createInstance($this);
-        $preTransformationEvent->setTransformation($transformation);
+        $preTransformationEvent = PreTransformationEvent::create($this, $transformation);
         Dispatcher::getInstance()->dispatch(self::EVENT_PRE_TRANSFORMATION, $preTransformationEvent);
 
         $writer = $this->writers[$transformation->getWriter()];

diff --git a/src/phpDocumentor/Transformer/Writer/WriterAbstract.php b/src/phpDocumentor/Transformer/Writer/WriterAbstract.php
@@ -57,4 +57,9 @@ protected function checkForSpacesInPath($path)
      * @param Transformation    $transformation Transformation to execute.
      */
     abstract public function transform(ProjectDescriptor $project, Transformation $transformation);
+
+    public function __toString(): string
+    {
+        return get_class($this);
+    }
 }