Passed
Push — master ( 682fcd...f00a38 )
by Julius
01:55
created

NoPrivateExtension   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 18
Duplicated Lines 100 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
dl 18
loc 18
rs 10
c 1
b 0
f 0
wmc 7

1 Method

Rating   Name   Duplication   Size   Complexity  
B shouldRenderElement() 16 16 7

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

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 phpDocumentor\Reflection\Element;
28
use phpDocumentor\Reflection\Php\Class_;
29
use phpDocumentor\Reflection\Php\Constant;
30
use phpDocumentor\Reflection\Php\Method;
31
use phpDocumentor\Reflection\Php\Property;
32
33
/**
34
 * Do not render classes marked with phpDoc internal tag
35
 * Do only render public methods/properties
36
 */
37
38 View Code Duplication
class NoPrivateExtension extends Extension {
0 ignored issues
show
Duplication introduced by
This class seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
39
40
    public function shouldRenderElement(Element $element) {
41
        if ($element instanceof Class_) {
42
            /** @var Class_ $class */
43
            $class = $element;
44
            if ($class->getDocBlock() !== null && $class->getDocBlock()->hasTag('internal')) {
45
                return false;
46
            }
47
        }
48
        if ($element instanceof Method || $element instanceof Property) {
49
            /** @var Method|Property $class */
50
            $class = $element;
51
            if ((string)$class->getVisibility() === 'private') {
52
                return false;
53
            }
54
        }
55
        return true;
56
    }
57
58
}