ParameterCommentGenerator::docBlock() - Code Metrics - jmartin82/DicDoc - Measure and Improve Code Quality continuously with Scrutinizer

ParameterCommentGenerator::docBlock() A
last analyzed 2016-04-15 23:42 UTC

↳ Parent: ParameterCommentGenerator

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	14
rs	9.4285
cc	3
eloc	7
nc	3
nop	1

<?php

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

namespace DicDoc;


/**
 * Class ParameterCommentGenerator
 *
 * @package DicDoc
 */
class ParameterCommentGenerator implements Interfaces\ParameterDocumentator
{
    /**
     * @var ParameterInformation
     */
    private $parameter;


    /**
     * @param ParameterInformation $parameter
     *
     * @return string
     */
    public function docBlock(ParameterInformation $parameter)
    {
        $this->parameter = $parameter;

        if (!$parameter->isObject()) {
            return $this->documentPrimitive();
        }

        if (empty($parameter->getImplements())) {
            return $this->documentClass();
        }

        return $this->documentInterfaces();
    }

    private function getVarNameProposal()
    {
        return lcfirst($this->parameter->getShortClassName());
    }

    private function documentPrimitive()
    {
        return "/** @var ".$this->parameter->getType()." */";
    }

    private function documentClass()
    {
        return "/** @var \\".$this->parameter->getClassName()." \$".$this->getVarNameProposal()." */";
    }

    private function documentInterfaces()
    {
        return "/** @var \\".implode("|\\", $this->parameter->getImplements())." \$".$this->getVarNameProposal()." */";
    }

}


1			<?php
2
3			/*
4			* To change this license header, choose License Headers in Project Properties.
5			* To change this template file, choose Tools \| Templates
6			* and open the template in the editor.
7			*/
8
9			namespace DicDoc;
10
11
12			/**
13			* Class ParameterCommentGenerator
14			*
15			* @package DicDoc
16			*/
17			class ParameterCommentGenerator implements Interfaces\ParameterDocumentator
18			{
19			/**
20			* @var ParameterInformation
21			*/
22			private $parameter;
23
24
25			/**
26			* @param ParameterInformation $parameter
27			*
28			* @return string
29			*/
30			public function docBlock(ParameterInformation $parameter)
31			{
32			$this->parameter = $parameter;
33
34			if (!$parameter->isObject()) {
35			return $this->documentPrimitive();
36			}
37
38			if (empty($parameter->getImplements())) {
39			return $this->documentClass();
40			}
41
42			return $this->documentInterfaces();
43			}
44
45			private function getVarNameProposal()
46			{
47			return lcfirst($this->parameter->getShortClassName());
48			}
49
50			private function documentPrimitive()
51			{
52			return "/** @var ".$this->parameter->getType()." */";
53			}
54
55			private function documentClass()
56			{
57			return "/** @var \\".$this->parameter->getClassName()." \$".$this->getVarNameProposal()." */";
58			}
59
60			private function documentInterfaces()
61			{
62			return "/** @var \\".implode("\|\\", $this->parameter->getImplements())." \$".$this->getVarNameProposal()." */";
63			}
64
65			}
66

jmartin82 / DicDoc

ParameterCommentGenerator::docBlock() A last analyzed 2016-04-15 23:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ParameterCommentGenerator::docBlock() A
last analyzed 2016-04-15 23:42 UTC