abbadon1334 / phpdoc-to-rst

src/ApiDocBuilder.php

Spacing +25 added lines, -25 removed lines

@@ -90,7 +90,7 @@ 
     public function __construct($srcDir, $dstDir)
     {
         $this->dstDir = $dstDir;
-        $this->srcDir = (array) $srcDir;
+        $this->srcDir = (array)$srcDir;
     }
 
     /**
@@ -125,7 +125,7 @@ 
                 try {
                     $interfaceList[] = new LocalFile($file->getPathname());
                 } catch (Exception $e) {
-                    $this->log('Failed to load '.$file->getPathname().PHP_EOL);
+                    $this->log('Failed to load ' . $file->getPathname() . PHP_EOL);
                 }
             }
         }
@@ -151,10 +151,10 @@ 
         foreach ($this->extensionNames as $extensionName) {
             $extension = new $extensionName($this->project, $this->extensionArguments[$extensionName]);
             if (!is_subclass_of($extension, Extension::class)) {
-                $this->log('Failed to load extension '.$extensionName.'.');
+                $this->log('Failed to load extension ' . $extensionName . '.');
             }
             $this->extensions[] = $extension;
-            $this->log('Extension '.$extensionName.' loaded.');
+            $this->log('Extension ' . $extensionName . ' loaded.');
         }
     }
 
@@ -166,7 +166,7 @@ 
     public function log($message)
     {
         if ($this->verboseOutput) {
-            echo $message.PHP_EOL;
+            echo $message . PHP_EOL;
         }
     }
 
@@ -178,12 +178,12 @@ 
     private function createDirectoryStructure()
     {
         foreach ($this->project->getNamespaces() as $namespace) {
-            $namespaceDir = $this->dstDir.str_replace('\\', '/', $namespace->getFqsen());
+            $namespaceDir = $this->dstDir . str_replace('\\', '/', $namespace->getFqsen());
             if (is_dir($namespaceDir)) {
                 continue;
             }
             if (!mkdir($namespaceDir, 0755, true)) {
-                throw new WriteException('Could not create directory '.$namespaceDir);
+                throw new WriteException('Could not create directory ' . $namespaceDir);
             }
         }
     }
@@ -219,7 +219,7 @@ 
     public function debug($message)
     {
         if ($this->debugOutput) {
-            echo $message.PHP_EOL;
+            echo $message . PHP_EOL;
         }
     }
 
@@ -228,13 +228,13 @@ 
         $this->log('Build indexes.');
         $namespaces = $this->project->getNamespaces();
         $namespaces['\\'] = $this->project->getRootNamespace();
-        usort($namespaces, function (Namespace_ $a, Namespace_ $b) {
+        usort($namespaces, function(Namespace_ $a, Namespace_ $b) {
             return strcmp($a->getFqsen(), $b->getFqsen());
         });
         /** @var Namespace_ $namespace */
         foreach ($namespaces as $namespace) {
-            $fqsen = (string) $namespace->getFqsen();
-            $this->debug('Build namespace index for '.$fqsen);
+            $fqsen = (string)$namespace->getFqsen();
+            $this->debug('Build namespace index for ' . $fqsen);
             $functions = [];
             $constants = [];
             if (array_key_exists($fqsen, $this->functions)) {
@@ -245,14 +245,14 @@ 
             }
             $builder = new NamespaceIndexBuilder($this->extensions, $namespaces, $namespace, $functions, $constants);
             $builder->render();
-            $path = $this->dstDir.str_replace('\\', '/', $fqsen).'/index.rst';
+            $path = $this->dstDir . str_replace('\\', '/', $fqsen) . '/index.rst';
             file_put_contents($path, $builder->getContent());
         }
 
         $this->log('Build main index files.');
         $builder = new MainIndexBuilder($namespaces);
         $builder->render();
-        $path = $this->dstDir.'/index-namespaces-all.rst';
+        $path = $this->dstDir . '/index-namespaces-all.rst';
         file_put_contents($path, $builder->getContent());
     }
 
@@ -295,15 +295,15 @@ 
         foreach ($file->getInterfaces() as $interface) {
             $fqsen = $interface->getFqsen();
             $builder = new InterfaceFileBuilder($file, $interface, $this->extensions);
-            $filename = $this->dstDir.str_replace('\\', '/', $fqsen).'.rst';
+            $filename = $this->dstDir . str_replace('\\', '/', $fqsen) . '.rst';
             file_put_contents($filename, $builder->getContent());
-            $this->docFiles[(string) $interface->getFqsen()] = str_replace('\\', '/', $fqsen);
+            $this->docFiles[(string)$interface->getFqsen()] = str_replace('\\', '/', $fqsen);
 
             // also build root namespace in indexes
-            if (strpos((string) substr($fqsen, 1), '\\') === false) {
+            if (strpos((string)substr($fqsen, 1), '\\') === false) {
                 $this->project->getRootNamespace()->addInterface($fqsen);
             }
-            $this->debug('Written interface documentation to '.$filename);
+            $this->debug('Written interface documentation to ' . $filename);
         }
     }
 
@@ -315,15 +315,15 @@ 
         foreach ($file->getClasses() as $class) {
             $fqsen = $class->getFqsen();
             $builder = new ClassFileBuilder($file, $class, $this->extensions);
-            $filename = $this->dstDir.str_replace('\\', '/', $fqsen).'.rst';
+            $filename = $this->dstDir . str_replace('\\', '/', $fqsen) . '.rst';
             file_put_contents($filename, $builder->getContent());
-            $this->docFiles[(string) $class->getFqsen()] = str_replace('\\', '/', $fqsen);
+            $this->docFiles[(string)$class->getFqsen()] = str_replace('\\', '/', $fqsen);
 
             // also build root namespace in indexes
-            if (strpos((string) substr($class->getFqsen(), 1), '\\') === false) {
+            if (strpos((string)substr($class->getFqsen(), 1), '\\') === false) {
                 $this->project->getRootNamespace()->addClass($fqsen);
             }
-            $this->debug('Written class documentation to '.$filename);
+            $this->debug('Written class documentation to ' . $filename);
         }
     }
 
@@ -335,15 +335,15 @@ 
         foreach ($file->getTraits() as $trait) {
             $fqsen = $trait->getFqsen();
             $builder = new TraitFileBuilder($file, $trait, $this->extensions);
-            $filename = $this->dstDir.str_replace('\\', '/', $fqsen).'.rst';
+            $filename = $this->dstDir . str_replace('\\', '/', $fqsen) . '.rst';
             file_put_contents($filename, $builder->getContent());
-            $this->docFiles[(string) $trait->getFqsen()] = str_replace('\\', '/', $fqsen);
+            $this->docFiles[(string)$trait->getFqsen()] = str_replace('\\', '/', $fqsen);
 
             // also build root namespace in indexes
-            if (strpos((string) substr($fqsen, 1), '\\') === false) {
+            if (strpos((string)substr($fqsen, 1), '\\') === false) {
                 $this->project->getRootNamespace()->addTrait($fqsen);
             }
-            $this->debug('Written trait documentation to '.$filename);
+            $this->debug('Written trait documentation to ' . $filename);
         }
     }
 

src/Middleware/ErrorHandlingMiddleware.php

Spacing +2 added lines, -2 removed lines

@@ -51,12 +51,12 @@
     public function execute(Command $command, callable $next): object
     {
         $filename = $command->getFile()->path();
-        $this->apiDocBuilder->debug('Starting to parse file: '.$filename);
+        $this->apiDocBuilder->debug('Starting to parse file: ' . $filename);
 
         try {
             return $next($command);
         } catch (Exception $e) {
-            $this->apiDocBuilder->log('Unable to parse file "'.$filename.'", '.$e->getMessage());
+            $this->apiDocBuilder->log('Unable to parse file "' . $filename . '", ' . $e->getMessage());
             //Must Return empty file object
             return new FileElement(
                 $command->getFile()->md5(),

src/Builder/PhpDomainBuilder.php

Spacing +34 added lines, -34 removed lines

@@ -43,10 +43,10 @@ 
  */
 class PhpDomainBuilder extends RstBuilder
 {
-    const SECTION_BEFORE_DESCRIPTION = self::class.'::SECTION_BEFORE_DESCRIPTION';
-    const SECTION_AFTER_DESCRIPTION = self::class.'::SECTION_AFTER_DESCRIPTION';
-    const SECTION_AFTER_TITLE = self::class.'::SECTION_AFTER_TITLE';
-    const SECTION_AFTER_INTRODUCTION = self::class.'::SECTION_AFTER_INTRODUCTION';
+    const SECTION_BEFORE_DESCRIPTION = self::class . '::SECTION_BEFORE_DESCRIPTION';
+    const SECTION_AFTER_DESCRIPTION = self::class . '::SECTION_AFTER_DESCRIPTION';
+    const SECTION_AFTER_TITLE = self::class . '::SECTION_AFTER_TITLE';
+    const SECTION_AFTER_INTRODUCTION = self::class . '::SECTION_AFTER_INTRODUCTION';
 
     use ExtensionBuilder {
         ExtensionBuilder::__construct as private __extensionConstructor;
@@ -55,7 +55,7 @@ 
     public function __construct($extensions)
     {
         $this->__extensionConstructor($extensions);
-        $this->addMultiline('.. role:: php(code)'.PHP_EOL.':language: php', true);
+        $this->addMultiline('.. role:: php(code)' . PHP_EOL . ':language: php', true);
         $this->addLine();
     }
 
@@ -74,7 +74,7 @@ 
             $modifiers = $element->isAbstract() ? ' abstract' : '';
             $modifiers = $element->isFinal() ? ' final' : $modifiers;
             if ($modifiers !== '') {
-                $this->addLine('.. rst-class:: '.$modifiers)->addLine();
+                $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
             }
         }
 
@@ -93,7 +93,7 @@ 
      */
     public static function getNamespace(Element $element)
     {
-        return substr($element->getFqsen(), 0, strlen($element->getFqsen()) - strlen('\\'.$element->getName()));
+        return substr($element->getFqsen(), 0, strlen($element->getFqsen()) - strlen('\\' . $element->getName()));
         //return str_replace('\\' . $element->getName(), '', $element->getFqsen());
     }
 
@@ -105,7 +105,7 @@ 
     public function beginPhpDomain($type, $name, $indent = true)
     {
         // FIXME: Add checks if it is properly ended
-        $this->addLine('.. php:'.$type.':: '.$name)->addLine();
+        $this->addLine('.. php:' . $type . ':: ' . $name)->addLine();
         if ($indent === true) {
             $this->indent();
         }
@@ -168,7 +168,7 @@ 
      */
     private function addConstant(Constant $constant)
     {
-        $this->beginPhpDomain('const', $constant->getName().' = '.self::escape($constant->getValue()));
+        $this->beginPhpDomain('const', $constant->getName() . ' = ' . self::escape($constant->getValue()));
         $docBlock = $constant->getDocBlock();
         $this->addDocBlockDescription($constant);
         if ($docBlock) {
@@ -195,7 +195,7 @@ 
             $this->addLine('.. rst-class:: phpdoc-description')->addLine();
             $this->indent();
             $this->addMultilineWithoutRendering(RstBuilder::escape($docBlock->getSummary()))->addLine();
-            if ((string) $docBlock->getDescription() !== '') {
+            if ((string)$docBlock->getDescription() !== '') {
                 $this->addMultilineWithoutRendering(RstBuilder::escape($docBlock->getDescription()))->addLine();
             }
             $this->unindent();
@@ -232,7 +232,7 @@ 
                 /** @var Return_ $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Returns: '.self::typesToRst($return->getType()).' '.RstBuilder::escape($return->getDescription()),
+                    ':Returns: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -240,7 +240,7 @@ 
                 /** @var DocBlock\Tags\Var_ $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Type: '.self::typesToRst($return->getType()).' '.RstBuilder::escape($return->getDescription()),
+                    ':Type: ' . self::typesToRst($return->getType()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -248,7 +248,7 @@ 
                 /** @var Throws $tag */
                 foreach ($tags as $tag) {
                     $this->addMultiline(
-                        ':Throws: '.self::typesToRst($tag->getType()).' '.RstBuilder::escape($tag->getDescription()),
+                        ':Throws: ' . self::typesToRst($tag->getType()) . ' ' . RstBuilder::escape($tag->getDescription()),
                         true
                     );
                 }
@@ -257,7 +257,7 @@ 
                 /** @var Since $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Since: '.$return->getVersion().' '.RstBuilder::escape($return->getDescription()),
+                    ':Since: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -265,7 +265,7 @@ 
                 /** @var Deprecated $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':Deprecated: '.$return->getVersion().' '.RstBuilder::escape($return->getDescription()),
+                    ':Deprecated: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
@@ -273,14 +273,14 @@ 
                 /** @var See $return */
                 $return = $tags[0];
                 $this->addMultiline(
-                    ':See: '.self::typesToRst($return->getReference()).' '.RstBuilder::escape($return->getDescription()),
+                    ':See: ' . self::typesToRst($return->getReference()) . ' ' . RstBuilder::escape($return->getDescription()),
                     true
                 );
                 break;
             case 'license':
                 /** @var DocBlock\Tags\BaseTag $return */
                 $return = $tags[0];
-                $this->addMultiline(':License: '.RstBuilder::escape($return->getDescription()), true);
+                $this->addMultiline(':License: ' . RstBuilder::escape($return->getDescription()), true);
                 break;
         }
     }
@@ -319,13 +319,13 @@ 
         foreach ($types as $typeFull) {
             $type = str_replace('[]', '', $typeFull);
             if (in_array($type, $whitelist, true)) {
-                $result .= $typeFull.' | ';
+                $result .= $typeFull . ' | ';
                 continue;
             }
             if (0 === strpos($type, '\\')) {
                 $type = substr($type, 1);
             }
-            $result .= ':any:`'.RstBuilder::escape($typeFull).' <'.RstBuilder::escape($type).'>` | ';
+            $result .= ':any:`' . RstBuilder::escape($typeFull) . ' <' . RstBuilder::escape($type) . '>` | ';
         }
 
         return substr($result, 0, -3);
@@ -363,7 +363,7 @@ 
     private function addProperty(Property $property)
     {
         $modifiers = $property->isStatic() ? '' : ' static';
-        $this->beginPhpDomain('attr', $property->getVisibility().$modifiers.' '.$property->getName());
+        $this->beginPhpDomain('attr', $property->getVisibility() . $modifiers . ' ' . $property->getName());
         $docBlock = $property->getDocBlock();
         $this->addDocBlockDescription($property);
         if ($docBlock) {
@@ -402,13 +402,13 @@ 
     public static function getLink($type, $fqsen, $description = '')
     {
         if ($description !== '') {
-            return ':php:'.$type.':`'.RstBuilder::escape($description).'<'.RstBuilder::escape(substr(
+            return ':php:' . $type . ':`' . RstBuilder::escape($description) . '<' . RstBuilder::escape(substr(
                 $fqsen,
                 1
-            )).'>`';
+            )) . '>`';
         }
 
-        return ':php:'.$type.':`'.RstBuilder::escape(substr($fqsen, 1)).'`';
+        return ':php:' . $type . ':`' . RstBuilder::escape(substr($fqsen, 1)) . '`';
     }
 
     /**
@@ -418,7 +418,7 @@ 
     {
         $usedTraits = '';
         foreach ($element->getUsedTraits() as $trait) {
-            $usedTraits .= $this->getLink('trait', $trait).' ';
+            $usedTraits .= $this->getLink('trait', $trait) . ' ';
         }
         if ($usedTraits !== '') {
             $this->addFieldList('Used traits', $usedTraits);
@@ -461,11 +461,11 @@ 
         $modifiers .= $method->isFinal() ? ' final' : '';
         $modifiers .= $method->isStatic() ? ' static' : '';
         $deprecated = count($deprecated) > 0 ? ' deprecated' : '';
-        $this->addLine('.. rst-class:: '.$modifiers.$deprecated)->addLine();
+        $this->addLine('.. rst-class:: ' . $modifiers . $deprecated)->addLine();
         $this->indent();
 
         $args = $this->processMethodArgumentTypes($method);
-        $this->beginPhpDomain('method', $modifiers.' '.$method->getName().'('.$args.')');
+        $this->beginPhpDomain('method', $modifiers . ' ' . $method->getName() . '(' . $args . ')');
         $this->addDocBlockDescription($method);
         $this->addLine();
         if (!empty($params)) {
@@ -507,12 +507,12 @@ 
                 if ($argument->isVariadic()) {
                     $paramItem .= '...';
                 }
-                $paramItem .= '$'.$argument->getName().'** ';
+                $paramItem .= '$' . $argument->getName() . '** ';
                 if ($typString !== null) {
-                    $paramItem .= '('.self::typesToRst($typString).') ';
+                    $paramItem .= '(' . self::typesToRst($typString) . ') ';
                 }
-                $paramItem .= ' '.$param->getDescription();
-                $parameterDetails .= $paramItem.PHP_EOL;
+                $paramItem .= ' ' . $param->getDescription();
+                $parameterDetails .= $paramItem . PHP_EOL;
             }
         }
 
@@ -544,20 +544,20 @@ 
     private function processMethodArgumentType(Argument $argument, string $args): string
     {
         foreach ($argument->getType() as $type) {
-            $args .= self::escape($type).'|';
+            $args .= self::escape($type) . '|';
         }
-        $args = substr($args, 0, -1).' ';
+        $args = substr($args, 0, -1) . ' ';
         if ($argument->isVariadic()) {
             $args .= '...';
         }
         if ($argument->isByReference()) {
             $args .= '&';
         }
-        $args .= '$'.$argument->getName();
+        $args .= '$' . $argument->getName();
         $default = $argument->getDefault();
         if ($default !== null) {
             $default = $default === '' ? '""' : $default;
-            $args .= '='.self::escape($default);
+            $args .= '=' . self::escape($default);
         }
         $args .= ', ';
 

src/Builder/NamespaceIndexBuilder.php

Spacing +16 added lines, -16 removed lines

@@ -70,24 +70,24 @@ 
      */
     private function findChildNamespaces()
     {
-        $currentNamespaceFqsen = (string) $this->currentNamespace->getFqsen();
+        $currentNamespaceFqsen = (string)$this->currentNamespace->getFqsen();
         /** @var Namespace_ $namespace */
         foreach ($this->namespaces as $namespace) {
             // check if not root and doesn't start with current namespace
             if ($currentNamespaceFqsen !== '\\' && strpos(
-                (string) $namespace->getFqsen(),
-                $currentNamespaceFqsen.'\\'
+                (string)$namespace->getFqsen(),
+                $currentNamespaceFqsen . '\\'
             ) !== 0) {
                 continue;
             }
-            if ((string) $namespace->getFqsen() !== $currentNamespaceFqsen && strpos(
-                (string) $namespace->getFqsen(),
+            if ((string)$namespace->getFqsen() !== $currentNamespaceFqsen && strpos(
+                (string)$namespace->getFqsen(),
                 $currentNamespaceFqsen
             ) === 0) {
                 // only keep first level children
                 $childrenPath = substr(
-                    (string) $namespace->getFqsen(),
-                    strlen((string) $this->currentNamespace->getFqsen()) + 1
+                    (string)$namespace->getFqsen(),
+                    strlen((string)$this->currentNamespace->getFqsen()) + 1
                 );
                 if (strpos($childrenPath, '\\') === false) {
                     $this->childNamespaces[] = $namespace;
@@ -98,15 +98,15 @@ 
 
     public function render()
     {
-        $currentNamespaceFqsen = (string) $this->currentNamespace->getFqsen();
+        $currentNamespaceFqsen = (string)$this->currentNamespace->getFqsen();
         if ($currentNamespaceFqsen !== '\\') {
             $label = str_replace('\\', '-', $currentNamespaceFqsen);
-            $this->addLine('.. _namespace'.$label.':')->addLine();
+            $this->addLine('.. _namespace' . $label . ':')->addLine();
             $this->addH1(RstBuilder::escape($this->currentNamespace->getName()));
             $this->addLine(self::escape($currentNamespaceFqsen))->addLine();
         } else {
             $label = 'root-namespace';
-            $this->addLine('.. _namespace-'.$label.':')->addLine();
+            $this->addLine('.. _namespace-' . $label . ':')->addLine();
             $this->addH1(RstBuilder::escape('\\'));
         }
         $this->addLine();
@@ -135,7 +135,7 @@ 
                     continue;
                 }
                 if ($type === self::RENDER_INDEX_NAMESPACE) {
-                    $this->addLine($entry->getName().' <'.$entry->getName().'/index>');
+                    $this->addLine($entry->getName() . ' <' . $entry->getName() . '/index>');
                 } else {
                     $this->addElementTocEntry($entry);
                 }
@@ -206,7 +206,7 @@ 
 
     private function addElementTocEntry(Fqsen $entry)
     {
-        $currentNamespaceFqsen = (string) $this->currentNamespace->getFqsen();
+        $currentNamespaceFqsen = (string)$this->currentNamespace->getFqsen();
         $subPath = $entry;
         if ($currentNamespaceFqsen !== '\\' && substr(
             $entry,
@@ -216,7 +216,7 @@ 
             $subPath = substr($entry, strlen($currentNamespaceFqsen));
         }
         $path = substr(str_replace('\\', '/', $subPath), 1);
-        $this->addLine($entry->getName().' <'.$path.'>');
+        $this->addLine($entry->getName() . ' <' . $path . '>');
     }
 
     private function addFunctions()
@@ -242,10 +242,10 @@ 
             /** @var Argument $argument */
             foreach ($function->getArguments() as $argument) {
                 // TODO: defaults, types
-                $args .= '$'.$argument->getName().', ';
+                $args .= '$' . $argument->getName() . ', ';
             }
             $args = substr($args, 0, -2);
-            $this->beginPhpDomain('function', $function->getName().'('.$args.')');
+            $this->beginPhpDomain('function', $function->getName() . '(' . $args . ')');
             $this->addDocBlockDescription($function);
             if (!empty($params)) {
                 foreach ($function->getArguments() as $argument) {
@@ -254,7 +254,7 @@ 
                         $param = $params[$argument->getName()];
                         if ($param !== null) {
                             $this->addMultiline(
-                                ':param '.self::escape($param->getType()).' $'.$argument->getName().': '.$param->getDescription(),
+                                ':param ' . self::escape($param->getType()) . ' $' . $argument->getName() . ': ' . $param->getDescription(),
                                 true
                             );
                         }