Swaggest\PhpCodeBuilder\Traits\Description

Complexity

Total Complexity

4

Size/Duplication

Total Lines	32
Duplicated Lines	0 %

Test Coverage

Coverage

60%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setDescription()	0	4	1
A	getDescription()	0	3	1
A	renderDescriptionAsPhpDoc()	0	7	2

<?php

namespace Swaggest\PhpCodeBuilder\Traits;


use Swaggest\PhpCodeBuilder\PhpDoc;

trait Description
{
    use PhpDocable;

    /** @var string */
    private $description;

    /**
     * @return string
     */
    public function getDescription()
    {
        return $this->description;
    }

    /**
     * @param string $description
     * @return $this
     */
    public function setDescription($description)
    {
        $this->description = $description;
        return $this;
    }

    private function renderDescriptionAsPhpDoc()
    {
        if ($this->description) {
            $this->getPhpDoc()->prepend(null, trim($this->description));
            return $this->getPhpDoc()->render();
        } else {
            return '';
        }
    }

}