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/Builder/RstBuilder.php

Spacing +7 added lines, -7 removed lines

@@ -26,7 +26,7 @@ 
 class RstBuilder
 {
     /** @var string */
-    protected $content = '.. rst-class:: phpdoctorst'.PHP_EOL.PHP_EOL;
+    protected $content = '.. rst-class:: phpdoctorst' . PHP_EOL . PHP_EOL;
     private $indentLevel = 0;
 
     public function getContent()
@@ -36,7 +36,7 @@ 
 
     public function addFieldList($key, $value)
     {
-        $this->addLine(':'.self::escape($key).':');
+        $this->addLine(':' . self::escape($key) . ':');
         $this->indent()->addMultiline($value, false)->unindent();
 
         return $this;
@@ -44,7 +44,7 @@ 
 
     public function addLine($text = '')
     {
-        $this->add(str_repeat("\t", $this->indentLevel).$text.PHP_EOL);
+        $this->add(str_repeat("\t", $this->indentLevel) . $text . PHP_EOL);
 
         return $this;
     }
@@ -104,7 +104,7 @@ 
     public function addH1(string $text)
     {
         $this->addLine($text);
-        $this->addLine(str_repeat('=', strlen((string) $text)))->addLine();
+        $this->addLine(str_repeat('=', strlen((string)$text)))->addLine();
 
         return $this;
     }
@@ -112,7 +112,7 @@ 
     public function addH2($text)
     {
         $this->addLine($text);
-        $this->addLine(str_repeat('-', strlen((string) $text)))->addLine();
+        $this->addLine(str_repeat('-', strlen((string)$text)))->addLine();
 
         return $this;
     }
@@ -120,7 +120,7 @@ 
     public function addH3($text)
     {
         $this->addLine($text);
-        $this->addLine(str_repeat('~', strlen((string) $text)))->addLine();
+        $this->addLine(str_repeat('~', strlen((string)$text)))->addLine();
 
         return $this;
     }
@@ -129,7 +129,7 @@ 
     {
         $lines = preg_split('/$\R?^/m', $text);
         foreach ($lines as $line) {
-            $this->addLine('| '.$line);
+            $this->addLine('| ' . $line);
         }
 
         return $this;

src/Builder/MainIndexBuilder.php

Spacing +3 added lines, -3 removed lines

@@ -44,13 +44,13 @@
         $this->indent();
         $this->addLine(':maxdepth: 1')->addLine();
         foreach ($this->namespaces as $namespace) {
-            $namespaceString = (string) $namespace->getFqsen();
+            $namespaceString = (string)$namespace->getFqsen();
             $subPath = $namespaceString;
-            $path = substr(str_replace('\\', '/', $subPath), 1).'/index';
+            $path = substr(str_replace('\\', '/', $subPath), 1) . '/index';
             if ($namespaceString === '\\') {
                 $path = 'index';
             }
-            $this->addLine($namespace->getFqsen().' <'.$path.'>');
+            $this->addLine($namespace->getFqsen() . ' <' . $path . '>');
         }
         $this->addLine();
         $this->addLine();