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

Documentator::document() A
last analyzed 2016-04-15 23:42 UTC

↳ Parent: Documentator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace DicDoc;

/**
 * Class Documentator
 *
 * @package DicDoc
 */
class Documentator
{

    /**
     * @var Interfaces\ParameterDocumentator
     */
    private $parameterCommentGenerator;

    /**
     * @var Interfaces\TextFileManipulator
     */
    private $commentAppender;


    /**
     * Documentator constructor.
     *
     * @param Interfaces\TextFileManipulator   $commentAppender
     * @param Interfaces\ParameterDocumentator $parameterCommentGenerator
     */
    public function __construct(
        Interfaces\TextFileManipulator $commentAppender,
        Interfaces\ParameterDocumentator $parameterCommentGenerator
    ) {


        $this->commentAppender = $commentAppender;
        $this->parameterCommentGenerator = $parameterCommentGenerator;
    }

    /**
     * @param ParameterInformation $parameterInformation
     * @param CallerPosition       $callerData
     * @param                      $offset
     */
    public function document(ParameterInformation $parameterInformation, CallerPosition $callerData, $offset)
    {
        $docBlock = $this->parameterCommentGenerator->docBlock($parameterInformation);
        $this->commentAppender->insertComment($callerData->getFile(), $docBlock, $callerData->getLine() + $offset);
    }

}

1			<?php
2			namespace DicDoc;
3
4			/**
5			* Class Documentator
6			*
7			* @package DicDoc
8			*/
9			class Documentator
10			{
11
12			/**
13			* @var Interfaces\ParameterDocumentator
14			*/
15			private $parameterCommentGenerator;
16
17			/**
18			* @var Interfaces\TextFileManipulator
19			*/
20			private $commentAppender;
21
22
23			/**
24			* Documentator constructor.
25			*
26			* @param Interfaces\TextFileManipulator $commentAppender
27			* @param Interfaces\ParameterDocumentator $parameterCommentGenerator
28			*/
29			public function __construct(
30			Interfaces\TextFileManipulator $commentAppender,
31			Interfaces\ParameterDocumentator $parameterCommentGenerator
32			) {
33
34
35			$this->commentAppender = $commentAppender;
36			$this->parameterCommentGenerator = $parameterCommentGenerator;
37			}
38
39			/**
40			* @param ParameterInformation $parameterInformation
41			* @param CallerPosition $callerData
42			* @param $offset
43			*/
44			public function document(ParameterInformation $parameterInformation, CallerPosition $callerData, $offset)
45			{
46			$docBlock = $this->parameterCommentGenerator->docBlock($parameterInformation);
47			$this->commentAppender->insertComment($callerData->getFile(), $docBlock, $callerData->getLine() + $offset);
48			}
49
50			}

jmartin82 / DicDoc

Documentator::document() A last analyzed 2016-04-15 23:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Documentator::document() A
last analyzed 2016-04-15 23:42 UTC