You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
100 lines
2.6 KiB
100 lines
2.6 KiB
<?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\DocBlock\Tags;
|
|
|
|
use phpDocumentor\Reflection\DocBlock\Description;
|
|
use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
|
|
use phpDocumentor\Reflection\Fqsen;
|
|
use phpDocumentor\Reflection\FqsenResolver;
|
|
use phpDocumentor\Reflection\Types\Context as TypeContext;
|
|
use phpDocumentor\Reflection\Utils;
|
|
use Webmozart\Assert\Assert;
|
|
use function array_key_exists;
|
|
use function explode;
|
|
|
|
/**
|
|
* Reflection class for a @covers tag in a Docblock.
|
|
*/
|
|
final class Covers extends BaseTag implements Factory\StaticMethod
|
|
{
|
|
/** @var string */
|
|
protected $name = 'covers';
|
|
|
|
/** @var Fqsen */
|
|
private $refers;
|
|
|
|
/**
|
|
* Initializes this tag.
|
|
*/
|
|
public function __construct(Fqsen $refers, ?Description $description = null)
|
|
{
|
|
$this->refers = $refers;
|
|
$this->description = $description;
|
|
}
|
|
|
|
public static function create(
|
|
string $body,
|
|
?DescriptionFactory $descriptionFactory = null,
|
|
?FqsenResolver $resolver = null,
|
|
?TypeContext $context = null
|
|
) : self {
|
|
Assert::stringNotEmpty($body);
|
|
Assert::notNull($descriptionFactory);
|
|
Assert::notNull($resolver);
|
|
|
|
$parts = Utils::pregSplit('/\s+/Su', $body, 2);
|
|
|
|
return new static(
|
|
self::resolveFqsen($parts[0], $resolver, $context),
|
|
$descriptionFactory->create($parts[1] ?? '', $context)
|
|
);
|
|
}
|
|
|
|
private static function resolveFqsen(string $parts, ?FqsenResolver $fqsenResolver, ?TypeContext $context) : Fqsen
|
|
{
|
|
Assert::notNull($fqsenResolver);
|
|
$fqsenParts = explode('::', $parts);
|
|
$resolved = $fqsenResolver->resolve($fqsenParts[0], $context);
|
|
|
|
if (!array_key_exists(1, $fqsenParts)) {
|
|
return $resolved;
|
|
}
|
|
|
|
return new Fqsen($resolved . '::' . $fqsenParts[1]);
|
|
}
|
|
|
|
/**
|
|
* Returns the structural element this tag refers to.
|
|
*/
|
|
public function getReference() : Fqsen
|
|
{
|
|
return $this->refers;
|
|
}
|
|
|
|
/**
|
|
* Returns a string representation of this tag.
|
|
*/
|
|
public function __toString() : string
|
|
{
|
|
if ($this->description) {
|
|
$description = $this->description->render();
|
|
} else {
|
|
$description = '';
|
|
}
|
|
|
|
$refers = (string) $this->refers;
|
|
|
|
return $refers . ($description !== '' ? ($refers !== '' ? ' ' : '') . $description : '');
|
|
}
|
|
}
|
|
|