klitsche/dog

<?php

declare(strict_types=1);

namespace Klitsche\Dog\Analyzer\Rules;

use Klitsche\Dog\Analyzer\Rule;
use Klitsche\Dog\Elements\DocBlockAwareInterface;
use Klitsche\Dog\Elements\ElementInterface;
use Klitsche\Dog\Elements\Function_;
use Klitsche\Dog\Elements\Method;
use phpDocumentor\Reflection\DocBlock;

/**
 * @link https://github.com/php-fig/fig-standards/blob/master/proposed/phpdoc-tags.md#511-return
 * @link https://docs.phpdoc.org/latest/guide/references/phpdoc/tags/return.html
 */
class DocBlockReturnDescriptionRule extends Rule
{
    public function analyze(ElementInterface $element): iterable
    {
        if (
            (
                $element instanceof Method
                || $element instanceof Function_
            )
            && $element instanceof DocBlockAwareInterface
            && $element->hasDocBlock() === true
            && $element->getDocBlock()->hasTag('return') !== false
        ) {
            foreach ($element->getDocBlock()->getTagsByName('return') as $tag) {
                if (
                    $tag instanceof DocBlock\Tags\Return_
                    && (string) $tag->getDescription() === ''
                ) {
                    yield $this->createIssue(
                        $element,
                        sprintf(
                            '@return description in DocBlock for %s %s not found',
                            $element->getElementType(),
                            $element->getId(),
                        ),
                        $element->getDocBlock()->getLocation()
                            ? $element->getDocBlock()->getLocation()->getLineNumber()
                            : 1
                    );
                }
            }
        }

        yield from [];
    }
}