abbadon1334 / phpdoc-to-rst

example/test-example.php

Spacing +3 added lines, -3 removed lines

@@ -17,12 +17,12 @@
  *  You should have received a copy of the GNU Affero General Public License
  *  along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-include __DIR__.'/../vendor/autoload.php';
+include __DIR__ . '/../vendor/autoload.php';
 
 use JuliusHaertl\PHPDocToRst\ApiDocBuilder;
 
-$src = [__DIR__.'/../src'];
-$dst = __DIR__.'/../tests/test-project-doc';
+$src = [__DIR__ . '/../src'];
+$dst = __DIR__ . '/../tests/test-project-doc';
 
 $apiDocBuilder = new ApiDocBuilder($src, $dst);
 $apiDocBuilder->setVerboseOutput(true);

src/Extension/GithubLocationExtension.php

Spacing +3 added lines, -3 removed lines

@@ -67,15 +67,15 @@
                 return;
             }
             $filePath = $builder->getFile()->getPath();
-            $filePath = preg_replace('/^'.preg_quote($this->basePath, '/').'/', '', $filePath);
+            $filePath = preg_replace('/^' . preg_quote($this->basePath, '/') . '/', '', $filePath);
             $lineNumber = $element->getLocation()->getLineNumber();
             $url = $this->getGithubLink($filePath, $lineNumber, $this->branch);
-            $builder->addFieldList('Source', '`'.$filePath.'#'.$lineNumber.' <'.$url.'>`_');
+            $builder->addFieldList('Source', '`' . $filePath . '#' . $lineNumber . ' <' . $url . '>`_');
         }
     }
 
     private function getGithubLink($file, $line = 1, $branch = 'master')
     {
-        return $this->githubRepo.'/blob/'.$branch.'/'.$file.'#L'.$line;
+        return $this->githubRepo . '/blob/' . $branch . '/' . $file . '#L' . $line;
     }
 }

src/Extension/PublicOnlyExtension.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
         if ($element instanceof Method || $element instanceof Property) {
             /** @var Method|Property $class */
             $class = $element;
-            if ((string) $class->getVisibility() !== 'public') {
+            if ((string)$class->getVisibility() !== 'public') {
                 return false;
             }
         }

src/Extension/AddFullElementNameExtension.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
             if ($element instanceof Class_) {
                 $modifiers = $element->isAbstract() ? 'abstract' : '';
                 $modifiers = $element->isFinal() ? ' final' : $modifiers;
-                $builder->addLine(':php:`'.$modifiers.' class '.RstBuilder::escape($builder->getElement()->getName()).' {}`');
+                $builder->addLine(':php:`' . $modifiers . ' class ' . RstBuilder::escape($builder->getElement()->getName()) . ' {}`');
                 $builder->addLine();
             }
         }

src/Extension/NoPrivateExtension.php

Spacing +1 added lines, -1 removed lines

@@ -43,7 +43,7 @@
         if ($element instanceof Method || $element instanceof Property) {
             /** @var Method|Property $class */
             $class = $element;
-            if ((string) $class->getVisibility() === 'private') {
+            if ((string)$class->getVisibility() === 'private') {
                 return false;
             }
         }

src/Extension/InterfaceImplementors.php

Spacing +6 added lines, -6 removed lines

@@ -38,10 +38,10 @@ 
         foreach ($this->project->getFiles() as $file) {
             foreach ($file->getClasses() as $class) {
                 foreach ($class->getInterfaces() as $interface) {
-                    if (!array_key_exists((string) $interface, $this->implementors)) {
-                        $this->implementors[(string) $interface] = [];
+                    if (!array_key_exists((string)$interface, $this->implementors)) {
+                        $this->implementors[(string)$interface] = [];
                     }
-                    $this->implementors[(string) $interface][] = $class->getFqsen();
+                    $this->implementors[(string)$interface][] = $class->getFqsen();
                 }
             }
         }
@@ -61,15 +61,15 @@ 
             /** @var Interface_ $interface */
             $interface = $builder->getElement();
             $content = '';
-            if (!array_key_exists((string) $interface->getFqsen(), $this->implementors)) {
+            if (!array_key_exists((string)$interface->getFqsen(), $this->implementors)) {
                 return;
             }
-            $implementors = $this->implementors[(string) $interface->getFqsen()];
+            $implementors = $this->implementors[(string)$interface->getFqsen()];
             if (count($implementors) === 0) {
                 return;
             }
             foreach ($implementors as $implementor) {
-                $content .= ':php:class:`'.RstBuilder::escape(substr($implementor, 1)).'` ';
+                $content .= ':php:class:`' . RstBuilder::escape(substr($implementor, 1)) . '` ';
             }
             $builder->addFieldList('Implemented by', $content);
             $builder->addLine();

src/Extension/TocExtension.php

Spacing +3 added lines, -3 removed lines

@@ -54,16 +54,16 @@
                         /** @var Argument $argument */
                         foreach ($method->getArguments() as $argument) {
                             // TODO: defaults, types
-                            $args .= '$'.$argument->getName().', ';
+                            $args .= '$' . $argument->getName() . ', ';
                         }
                         $args = substr($args, 0, -2);
                         $modifiers = $method->getVisibility();
                         $modifiers .= $method->isAbstract() ? ' abstract' : '';
                         $modifiers .= $method->isFinal() ? ' final' : '';
                         $modifiers .= $method->isStatic() ? ' static' : '';
-                        $signature = $modifiers.' '.$method->getName().'('.$args.')';
+                        $signature = $modifiers . ' ' . $method->getName() . '(' . $args . ')';
 
-                        $builder->addLine('* '.PhpDomainBuilder::getLink('meth', $method->getFqsen(), $signature));
+                        $builder->addLine('* ' . PhpDomainBuilder::getLink('meth', $method->getFqsen(), $signature));
                     }
                     $builder->addLine()->addLine();
                 }

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);
             }
         }
     }
@@ -202,43 +202,43 @@ 
             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);
             }
 
             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);
             }
 
             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);
             }
 
             // build array of functions per namespace
@@ -270,7 +270,7 @@ 
     public function debug($message)
     {
         if ($this->debugOutput) {
-            echo $message.PHP_EOL;
+            echo $message . PHP_EOL;
         }
     }
 
@@ -279,13 +279,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)) {
@@ -296,14 +296,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());
     }
 

src/Middleware/ErrorHandlingMiddleware.php

Spacing +2 added lines, -2 removed lines

@@ -50,12 +50,12 @@
     public function execute($command, callable $next)
     {
         $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());
         }
     }
 }