Spiral\Reactor\Traits\CommentTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	initComment()	0	8	2
A	setComment()	0	12	4
A	getComment()	0	4	1

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Reactor\Traits;

use Spiral\Reactor\Body\DocComment;

/**
 * Element can have doc comment.
 */
trait CommentTrait
{
    /**
     * @var DocComment
     */
    private $docComment = null;

    /**
     * Get associated file comment.
     *
     * @return DocComment
     */
    public function getComment(): DocComment
    {
        return $this->docComment;
    }

    /**
     * Set comment value.
     *
     * @param string|array $comment
     *
     * @return $this
     */
    public function setComment($comment)
    {
        if (!empty($comment)) {
            if (is_array($comment)) {
                $this->docComment->setLines($comment);
            } elseif (is_string($comment)) {
                $this->docComment->setString($comment);
            }
        }

        return $this;
    }

    /**
     * Init comment value.
     *
     * @param string|array $comment
     */
    private function initComment($comment)
    {
        if (empty($this->docComment)) {
            $this->docComment = new DocComment();
        }

        $this->setComment($comment);
    }
}