TocExtension::render() - Code Metrics - Inspection of "Fix small issue with type annotation and remove em..." - juliushaertl/phpdoc-to-rst - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 682fcd...f00a38 )

by Julius

created 2017-10-18 09:12 UTC

TocExtension::render() C

↳ Parent: TocExtension

Complexity

Conditions	11
Paths	20

Size

Total Lines	29
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	11
eloc	19
nc	20
nop	3
dl	0
loc	29
rs	5.2653
c	2
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\Extension;

use JuliusHaertl\PHPDocToRst\Builder\FileBuilder;
use JuliusHaertl\PHPDocToRst\Builder\InterfaceFileBuilder;
use JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder;
use JuliusHaertl\PHPDocToRst\Builder\RstBuilder;
use phpDocumentor\Reflection\Php\Argument;
use phpDocumentor\Reflection\Php\Class_;
use phpDocumentor\Reflection\Php\Interface_;
use PhpParser\Builder\Trait_;

/**
 * This extension will render a list of methods  for easy access
 * at the beginning of classes, interfaces and traits
 */

class TocExtension extends Extension {

    /**
     * @param string $type
     * @param FileBuilder $builder
     */
    public function render($type, &$builder, $element) {
        if ($type === PhpDomainBuilder::SECTION_AFTER_INTRODUCTION) {
            if ($element instanceof Class_ || $element instanceof Interface_ || $element instanceof Trait_) {
                $builder->addLine();
                $builder->addH2('Summary');

                /** @var Interface_ $interface */
                $interface = $builder->getElement();

                if(count($interface->getMethods()) > 0) {
                    $builder->addH3('Methods');
                    foreach ($interface->getMethods() as $method) {
                        $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' : '';
                        $signature = $modifiers . ' ' . $method->getName() . '(' . $args . ')';

                        $builder->addLine('* ' . PhpDomainBuilder::getLink('meth', $method->getFqsen(), $signature));

                    }
                    $builder->addLine()->addLine();
                }
            }
        }

    }
}

1			<?php
2			/**
3			* @copyright Copyright (c) 2017 Julius Härtl <[email protected]>
4			*
5			* @author Julius Härtl <[email protected]>
6			*
7			* @license GNU AGPL version 3 or any later version
8			*
9			* This program is free software: you can redistribute it and/or modify
10			* it under the terms of the GNU Affero General Public License as
11			* published by the Free Software Foundation, either version 3 of the
12			* License, or (at your option) any later version.
13			*
14			* This program is distributed in the hope that it will be useful,
15			* but WITHOUT ANY WARRANTY; without even the implied warranty of
16			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17			* GNU Affero General Public License for more details.
18			*
19			* You should have received a copy of the GNU Affero General Public License
20			* along with this program. If not, see <http://www.gnu.org/licenses/>.
21			*
22			*/
23
24			namespace JuliusHaertl\PHPDocToRst\Extension;
25
26			use JuliusHaertl\PHPDocToRst\Builder\FileBuilder;
27			use JuliusHaertl\PHPDocToRst\Builder\InterfaceFileBuilder;
28			use JuliusHaertl\PHPDocToRst\Builder\PhpDomainBuilder;
29			use JuliusHaertl\PHPDocToRst\Builder\RstBuilder;
30			use phpDocumentor\Reflection\Php\Argument;
31			use phpDocumentor\Reflection\Php\Class_;
32			use phpDocumentor\Reflection\Php\Interface_;
33			use PhpParser\Builder\Trait_;
34
35			/**
36			* This extension will render a list of methods for easy access
37			* at the beginning of classes, interfaces and traits
38			*/
39
40			class TocExtension extends Extension {
41
42			/**
43			* @param string $type
44			* @param FileBuilder $builder
45			*/
46			public function render($type, &$builder, $element) {
47			if ($type === PhpDomainBuilder::SECTION_AFTER_INTRODUCTION) {
48			if ($element instanceof Class_ \|\| $element instanceof Interface_ \|\| $element instanceof Trait_) {
49			$builder->addLine();
50			$builder->addH2('Summary');
51
52			/** @var Interface_ $interface */
53			$interface = $builder->getElement();
54
55			if(count($interface->getMethods()) > 0) {
56			$builder->addH3('Methods');
57			foreach ($interface->getMethods() as $method) {
58			$args = '';
59			/** @var Argument $argument */
60			foreach ($method->getArguments() as $argument) {
61			// TODO: defaults, types
62			$args .= '$' . $argument->getName() . ', ';
63			}
64			$args = substr($args, 0, -2);
65			$modifiers = $method->getVisibility();
66			$modifiers .= $method->isAbstract() ? ' abstract' : '';
67			$modifiers .= $method->isFinal() ? ' final' : '';
68			$modifiers .= $method->isStatic() ? ' static' : '';
69			$signature = $modifiers . ' ' . $method->getName() . '(' . $args . ')';
70
71			$builder->addLine('* ' . PhpDomainBuilder::getLink('meth', $method->getFqsen(), $signature));
72
73			}
74			$builder->addLine()->addLine();
75			}
76			}
77			}
78
79			}
80			}

juliushaertl / phpdoc-to-rst

Push — master ( 682fcd...f00a38 )

TocExtension::render() C

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like