Wingu\OctopusCore\Reflection\ReflectionDocCommentTrait

Complexity

Total Complexity

2

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	getReflectionDocComment()	0	8	2
	getDocComment()	0	1	?

<?php

namespace Wingu\OctopusCore\Reflection;

/**
 * Trait fot getting the documentation comment.
 */
trait ReflectionDocCommentTrait
{

    /**
     * The documentation comment object.
     *
     * @var \Wingu\OctopusCore\Reflection\ReflectionDocComment
     */
    protected $reflectionDocComment;

    /**
     * Get the document of the method.
     * 
     * @param string $trimLinePattern Pattern for trim() function applied to each line. Usefull to leave spaces or tabs. The default is the same as calling trim() without the argument.
     * @return \Wingu\OctopusCore\Reflection\ReflectionDocComment
     */
    public function getReflectionDocComment($trimLinePattern = " \t\n\r\0\x0B")
    {
        if ($this->reflectionDocComment === null) {
            $this->reflectionDocComment = new ReflectionDocComment((string)$this->getDocComment(), $trimLinePattern);
        }

        return $this->reflectionDocComment;
    }

    /**
     * Return the string containing the current constant comment or false if there's no comment.
     *
     * @return string|false
     */
    abstract public function getDocComment();
}