Builder::addDocblockTag() - Code Metrics - Inspection of "Docs: Add doc skeleton" - juliushaertl/phpdoc-to-rst - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b2175e...d070b7 )

by Julius

created 2017-10-07 12:04 UTC

Builder::addDocblockTag() C

↳ Parent: Builder

Complexity

Conditions	14
Paths	14

Size

Total Lines	46
Code Lines	38

Duplication

Lines	30
Ratio	65.22 %

Importance

Changes

Metric	Value
cc	14
eloc	38
nc	14
nop	2
dl	30
loc	46
rs	5.0744
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * @copyright Copyright (c) 2017 Julius Härtl <[email protected]>
 *
 * @author Julius Härtl <[email protected]>
 *
 * @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 JuliusHaertl\PHPDocToRst\Extension\Extension;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlock\Tags\Deprecated;
use phpDocumentor\Reflection\DocBlock\Tags\Return_;
use phpDocumentor\Reflection\DocBlock\Tags\See;
use phpDocumentor\Reflection\DocBlock\Tags\Since;
use phpDocumentor\Reflection\DocBlock\Tags\Throws;
use phpDocumentor\Reflection\Element;
use phpDocumentor\Reflection\File;
use phpDocumentor\Reflection\Fqsen;


abstract class Builder extends RstBuilder {

    /** @var File */
    protected $file;

    /** @var Element */
    protected $element;

    /** @var Extension[] */
    protected $extensions = [];

    private $phpDomains = [];


    protected abstract function render();

    public function __construct($file, $element, $extensions) {
        $this->file = $file;
        $this->extensions = $extensions;
        $this->element = $element;
        $this->render();
    }

    /**
     * @return Element that is used to build the rst file
     */
    public function getElement() {
        return $this->element;
    }

    public function getLink($type, $fqsen) {
        return ':php:' . $type . ':`' . RstBuilder::escape(substr($fqsen, 1)) . '`';
    }

    public function beginPhpDomain($type, $name, $indent=true) {
        // FIXME: Add checks if it is properly ended
        $this->addLine('.. php:' . $type . ':: '. $name)->addLine();
        if ($indent === true) {
            $this->indent();
        }
    }

    public function endPhpDomain($type='') {
    public function endPhpDomain(/** @scrutinizer ignore-unused */ $type='') {
        $this->unindent();
        $this->addLine();
    }

    /**
     * @param string $tag Name of the tag to parse
     * @param DocBlock $docBlock
     */
    protected function addDocblockTag($tag, DocBlock $docBlock) {
        $indent = 0;
        $tags = $docBlock->getTagsByName($tag);
        switch ($tag) {
            case 'return':

                if (sizeof($tags) === 0) continue;
                /** @var Return_ $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':returns: ' . $return->getType() . ' ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'throws':

                if (sizeof($tags) === 0) continue;
                /** @var Throws $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':throws: ' . $return->getType() . ' ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'since':

                if (sizeof($tags) === 0) continue;
                /** @var Since $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':since: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'deprecated':

                if (sizeof($tags) === 0) continue;
                /** @var Deprecated $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':deprecated: ' . $return->getVersion() . ' ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'see':

                if (sizeof($tags) === 0) continue;
                /** @var See $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':see: ' . $return->getReference() . ' ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'license':
                if (sizeof($tags) === 0) continue;
                /** @var DocBlock\Tags\BaseTag $return */
                $return = $tags[0];
                $this->addIndentMultiline($indent, ':license: ' . RstBuilder::escape($return->getDescription()), true);
                break;
            case 'param':
                // param handling is done by subclasses since it is more that docbook parsing
                break;
            default:
                echo 'Tag handling not defined for: ' . $tag . PHP_EOL;
                break;
        }

    }


}

juliushaertl / phpdoc-to-rst

Push — master ( b2175e...d070b7 )

Builder::addDocblockTag() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like