ClassString.php
No OneTemporary
Actions

Size

1 KB

Referenced Files

None

Subscribers

None

ClassString.php
View Options

	<?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 http://phpdoc.org
	*/

	namespace phpDocumentor\Reflection\Types;

	use phpDocumentor\Reflection\Fqsen;
	use phpDocumentor\Reflection\PseudoType;
	use phpDocumentor\Reflection\Type;

	/**
	* Value Object representing the type 'string'.
	*
	* @psalm-immutable
	*/
	final class ClassString extends String_ implements PseudoType
	{
	/** @var Fqsen\|null */
	private $fqsen;

	/**
	* Initializes this representation of a class string with the given Fqsen.
	*/
	public function __construct(?Fqsen $fqsen = null)
	{
	$this->fqsen = $fqsen;
	}

	public function underlyingType(): Type
	{
	return new String_();
	}

	/**
	* Returns the FQSEN associated with this object.
	*/
	public function getFqsen(): ?Fqsen
	{
	return $this->fqsen;
	}

	/**
	* Returns a rendered output of the Type as it would be used in a DocBlock.
	*/
	public function __toString(): string
	{
	if ($this->fqsen === null) {
	return 'class-string';
	}

	return 'class-string<' . (string) $this->fqsen . '>';
	}
	}