AlexWells\ApiDocsGenerator\Parsers\DocBlockWrapper

Complexity

Total Complexity

4

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getDocTag()	0	3	1
A	hasDocTag()	0	3	1
A	getDocTags()	0	10	2

<?php

namespace AlexWells\ApiDocsGenerator\Parsers;

use Mpociot\Reflection\DocBlock;
use Illuminate\Support\Collection;
use Mpociot\Reflection\DocBlock\Tag;

class DocBlockWrapper extends DocBlock
{
    /**
     * Returns doc tags by name (ignore case).
     *
     * @param string $name
     *
     * @return Collection|Tag[]
     */
    public function getDocTags($name = null)
    {
        $tags = collect($this->getTags());

        if ($name === null) {
            return $tags;
        }

        return $tags->filter(function (Tag $tag) use ($name) {
            return strtolower($tag->getName()) === strtolower($name);
        });
    }

    /**
     * Returns doc tag by name (ignore case).
     *
     * @param string $name
     *
     * @return Tag
     */
    public function getDocTag($name)
    {
        return $this->getDocTags($name)->first();
    }

    /**
     * Checks if doc contains specified tag (ignore case).
     *
     * @param string $name
     *
     * @return bool
     */
    public function hasDocTag($name)
    {
        return $this->getDocTags($name)->isNotEmpty();
    }
}