JuliusHaertl\PHPDocToRst\Builder\ClassFileBuilder

Complexity

Total Complexity

28

Size/Duplication

Total Lines	113
Duplicated Lines	6.19 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
F	render()	7	111	28

<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <jus@bitgrid.net>
 *
 * @author Julius Härtl <jus@bitgrid.net>
 *
 * @license GNU AGPL version 3 or any later version
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Affero General Public License for more details.
 *
 *  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/>.
 *
 */

namespace JuliusHaertl\PHPDocToRst\Builder;

use phpDocumentor\Reflection\DocBlock\Tags\Param;
use phpDocumentor\Reflection\Php\Argument;
use phpDocumentor\Reflection\Php\Class_;

class ClassFileBuilder extends FileBuilder {

    protected function render() {

        /** @var Class_ $class */
        $class = $this->element;

        if (!$this->shouldRenderElement($class)) {
            return;
        }

        $docBlock = $class->getDocBlock();

        $this->addH1(self::escape($class->getName()));

        $namespace = substr($class->getFqsen(), 0, strlen($class->getFqsen())-strlen('\\' . $class->getName()));
        if($namespace !== '') {
            $this->beginPhpDomain('namespace', substr($namespace, 1), false);
        }

        $modifiers = $class->isAbstract() ? ' abstract' : '';
        $modifiers = $class->isFinal() ? ' final' : $modifiers;
        if ($modifiers !== '') {
            $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
        }
        $this->beginPhpDomain('class', $class->getName(), false);

        $this->indent();
        $this->addDocBlockDescription($docBlock);

        if($class instanceof Class_) {
            // Add class details
            $parent = $class->getParent();
            if ($parent !== null) {
                $this->addFieldList('Extends', $parent !== null ? $this->getLink('class', $parent) : '');
            }
        }
        $implementedInterfaces = '';
        foreach ($class->getInterfaces() as $int) {
            $implementedInterfaces .= $this->getLink('interface', $int) . ' ';
        }
        if ($implementedInterfaces !== '') {
            $this->addFieldList('Implements', $implementedInterfaces);
        }

        $usedTraits = '';
        foreach ($class->getUsedTraits() as $trait) {
            $usedTraits .= $this->getLink('trait', $trait) . ' ';
        }
        if ($usedTraits !== '') {
            $this->addFieldList('Used traits', $usedTraits);
        }

        $this->unindent();
        $this->addLine();
        $this->addLine();

        // Add class constants
        if (count($class->getConstants()) > 0) {
            $this->addH2('Constants');
            foreach ($class->getConstants() as $constant) {
                if ($this->shouldRenderElement($constant)) {
                    $this->addConstant($constant);
                }
            }
        }

        $this->addProperties($class->getProperties());

        if (count($class->getMethods()) > 0) {
            $this->addH2('Methods');
            /* Render methods of a class */
            foreach ($class->getMethods() as $method) {
                if (!$this->shouldRenderElement($method)) {
                    continue;
                }
                $docBlock = $method->getDocBlock();
                $params = [];
                if ($docBlock !== null) {
                    /** @var Param $param */
                    foreach ($docBlock->getTagsByName('param') as $param) {
                        $params[$param->getVariableName()] = $param;

The method getVariableName() does not exist on phpDocumentor\Reflection\DocBlock\Tag. It seems like you code against a sub-type of phpDocumentor\Reflection\DocBlock\Tag such as phpDocumentor\Reflection\DocBlock\Tags\Property or phpDocumentor\Reflection\DocBlock\Tags\Var_ or phpDocumentor\Reflection\DocBlock\Tags\Param or phpDocumentor\Reflection\DocBlock\Tags\PropertyWrite or phpDocumentor\Reflection\DocBlock\Tags\PropertyRead.

                    }
                }
                $args = '';
                /** @var Argument $argument */
                foreach ($method->getArguments() as $argument) {
                    // TODO: defaults, types
                    $args .= ' $' . $argument->getName() . ', ';
                }
                $args = substr($args, 0, -2);

                $modifiers = $method->getVisibility();
                $modifiers .= $method->isAbstract() ? ' abstract' : '';
                $modifiers .= $method->isFinal() ? ' final' : '';
                $modifiers .= $method->isStatic() ? ' static' : '';
                $this->addLine('.. rst-class:: ' . $modifiers)->addLine();
                $this->indent();
                $this->beginPhpDomain('method', $method->getName() . '(' . $args . ')');
                $this->addDocBlockDescription($docBlock);
                $this->addLine();
                if (!empty($params)) {

This code seems to be duplicated across your project.

                    foreach ($method->getArguments() as $argument) {
                        /** @var Param $param */
                        $param = $params[$argument->getName()];
                        if ($param !== null) $this->addMultiline(':param ' . self::escape($param->getType()) . ' $' . $argument->getName() . ': ' . $param->getDescription(), true);
                    }
                }
                $this->endPhpDomain('method');
                $this->unindent();
            }
        }
        $this->endPhpDomain(); //class
    }

}