Your IP : 216.73.216.43


Current Path : /home/rtorresani/www/vendor/laminas/laminas-code/src/Reflection/DocBlock/Tag/
Upload File :
Current File : //home/rtorresani/www/vendor/laminas/laminas-code/src/Reflection/DocBlock/Tag/VarTag.php

<?php

namespace Laminas\Code\Reflection\DocBlock\Tag;

use function explode;
use function preg_match;
use function rtrim;

use const PHP_EOL;

class VarTag implements TagInterface, PhpDocTypedTagInterface
{
    /**
     * @var string[]
     * @psalm-var list<string>
     */
    private $types = [];

    /** @var string|null */
    private $variableName;

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

    /** @inheritDoc */
    public function getName(): string
    {
        return 'var';
    }

    /** @inheritDoc */
    public function initialize($content): void
    {
        $match = [];

        if (
            ! preg_match(
                '#^([^\$]\S+)?\s*(\$[\S]+)?\s*(.*)$#m',
                $content,
                $match
            )
        ) {
            return;
        }

        if ($match[1] !== '') {
            $this->types = explode('|', rtrim($match[1]));
        }

        if ($match[2] !== '') {
            $this->variableName = $match[2];
        }

        if ($match[3] !== '') {
            $this->description = $match[3];
        }
    }

    /** @inheritDoc */
    public function getTypes(): array
    {
        return $this->types;
    }

    public function getVariableName(): ?string
    {
        return $this->variableName;
    }

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

    /**
     * @psalm-return non-empty-string
     */
    public function __toString(): string
    {
        return 'DocBlock Tag [ * @' . $this->getName() . ' ]' . PHP_EOL;
    }
}