DicDoc\Documentator

Complexity

Total Complexity

2

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	document()	0	5	1

<?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);
    }

}