<?php

declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @link https://phpdoc.org
 */

namespace phpDocumentor\Descriptor\DocBlock;

use phpDocumentor\Descriptor\TagDescriptor;
use phpDocumentor\Reflection\DocBlock\Description;
use Stringable;

use function trim;
use function vsprintf;

final class DescriptionDescriptor implements Stringable
{
    /** @var Description */
    private $description;

    /** @var array<int, TagDescriptor|null> */
    private $inlineTags;

    /** @param array<int, TagDescriptor|null> $tags */
    public function __construct(Description|null $description, array $tags)
    {
        $this->description = $description ?? new Description('');
        $this->inlineTags = $tags;
    }

    public static function createEmpty(): self
    {
        return new self(new Description(''), []);
    }

    public function getBodyTemplate(): string
    {
        return $this->description->getBodyTemplate();
    }

    public function replaceTag(int $position, TagDescriptor|null $tagDescriptor): void
    {
        $this->inlineTags[$position] = $tagDescriptor;
    }

    /**
     * Returns the tags for this description
     *
     * @return array<int, TagDescriptor|null>
     */
    public function getTags(): array
    {
        return $this->inlineTags;
    }

    public function isEmpty(): bool
    {
        return $this->description->getBodyTemplate() === '';
    }

    /**
     * Renders docblock as string.
     *
     * This method is here for legacy purpose. The new v3 template has improved the way we render descriptons
     * which requires more advanced handling of descriptions and just not some string jugling.
     *
     * @deprecated will be removed in v4
     */
    public function __toString(): string
    {
        $tags = [];
        foreach ($this->getTags() as $tag) {
            if ($tag === null) {
                $tags[] = null;
                continue;
            }

            $tags[] = '{' . trim('@' . $tag->getName() . ' ' . $tag) . '}';
        }

        return vsprintf($this->getBodyTemplate(), $tags);
    }
}
