Class Salient\PHPDoc\PHPDoc

`implements`	`Immutable, Stringable`
`uses`	`ImmutableTrait`

A PSR-5 PHPDoc

Summaries that break over multiple lines are unwrapped. Descriptions and tags may contain Markdown, including fenced code blocks.

Methods


					
	public
					static

forClass(ReflectionClass<*> $class, array<string, class-string> $aliases = []): static

Creates a new PHPDoc object for a class from its doc comments


					
	public
					static

forMethod(
	ReflectionMethod $method,
	ReflectionClass<*>|null $class = null,
	array<string, class-string> $aliases = [],
): static

Creates a new PHPDoc object for a method from its doc comments


					
	public
					static

forProperty(
	ReflectionProperty $property,
	ReflectionClass<*>|null $class = null,
	array<string, class-string> $aliases = [],
): static

Creates a new PHPDoc object for a property from its doc comments


					
	public
					static

forConstant(
	ReflectionClassConstant $constant,
	ReflectionClass<*>|null $class = null,
	array<string, class-string> $aliases = [],
): static

Creates a new PHPDoc object for a class constant from its doc comments


					
	public
					static

fromTags(
	AbstractTag[] $tags,
	?string $summary = null,
	?string $description = null,
	class-string|null $class = null,
	?string $member = null,
): static

Creates a new PHPDoc object from an array of tag objects


					
	public

inherit(self $parent): static

Inherit values from an instance that represents the same structural element in a parent class or interface


					
	public

normalise(): static

Get a normalised instance

If the PHPDoc has one @var tag:

if the class member associated with the PHPDoc is a property with the same name as the tag, the name is removed from the tag
if the tag has no name, its description is applied to the summary or description of the PHPDoc and removed from the tag

@inheritDoc tags are removed.


					
	public

flatten(): static

Flatten values inherited from other instances and forget the initial state of the PHPDoc


					
	public

getOriginal(): static

Get the state of the PHPDoc before inheriting values from other instances


					
	public

getSummary(): ?string

Get the PHPDoc's summary


					
	public

getDescription(): ?string

Get the PHPDoc's description


					
	public

hasTag(string $name): bool

Check if the PHPDoc has a tag with the given name


					
	public

getTags(): array<string, AbstractTag[]>

Get the PHPDoc's tags, indexed by tag name


					
	public

getParams(): array<string, ParamTag>

Get the PHPDoc's "@param" tags, indexed by name


					
	public

hasReturn(): bool

Check if the PHPDoc has a "@return" tag


					
	public

getReturn(): ?ReturnTag

Get the PHPDoc's "@return" tag


					
	public

getVars(): VarTag[]

Get the PHPDoc's "@var" tags


					
	public

getMethods(): array<string, MethodTag>

Get the PHPDoc's "@method" tags, indexed by name


					
	public

getProperties(): array<string, PropertyTag>

Get the PHPDoc's "@property" tags, indexed by name


					
	public

getTemplates(bool $includeClass = true): array<string, TemplateTag>

Get the PHPDoc's "@template" tags, indexed by name


					
	public

getClassTemplates(): array<string, TemplateTag>

Get the PHPDoc's class "@template" tags, indexed by name


					
	public

getTagTemplates(AbstractTag $tag): array<string, TemplateTag>

Get "@template" tags applicable to the given tag, indexed by name


					
	public

hasErrors(): bool

Check if any tags in the PHPDoc's original DocBlock failed to parse


					
	public

getErrors(): ErrorTag[]

Get any tags that failed to parse


					
	public

getClass(): class-string|null

Get the name of the class associated with the PHPDoc


					
	public

getMember(): ?string

Get the class member associated with the PHPDoc


					
	public

getStatic(): class-string|null

Get the class to which relative types 'static' and '$this' should resolve


					
	public

getSelf(): class-string|null

Get the class to which relative type 'self' should resolve


					
	public

isEmpty(): bool

Check if the PHPDoc has no content


					
	public

hasDetail(): bool

Check if the PHPDoc has data other than a summary and standard type information


					
	public

__toString(): string

Implements

Stringable::__toString()


					
	public
					static

fromDocBlocks(
	array<class-string|int, array<class-string, string|null>|string|null> $docBlocks,
	array<class-string|int, self|string|null>|null $classDocBlocks = null,
	?string $member = null,
	class-string|null $static = null,
	array<string, class-string> $aliases = [],
): static

Creates a new PHPDoc object from an array of PHP DocBlocks, each of which inherits from subsequent blocks

Parameters

$static

The class to which 'static' and '$this' should resolve.

Methods used from Salient\Core\Concern\ImmutableTrait
`with(), without(), handlePropertyChanged()`

Constants
`protected`	`DEFAULT_TAG_PREFIXES = ['', 'phpstan-', 'psalm-']`	#
`protected`	INHERITABLE_TAGS = [ 'author' => false, 'copyright' => false, 'version' => false, 'package' => false, 'param' => true, 'return' => true, 'throws' => true, 'var' => true, 'method' => true, 'property' => true, 'property-read' => ['phpstan-', 'psalm-'], 'property-write' => ['phpstan-', 'psalm-'], 'mixin' => true, 'param-out' => true, 'param-immediately-invoked-callable' => ['', 'phpstan-'], 'param-later-invoked-callable' => ['', 'phpstan-'], 'param-closure-this' => ['', 'phpstan-'], 'deprecated' => false, 'readonly' => false, ] [ Tag => [ prefix, ... ] \| apply default prefixes?, ... ] [ Tag => [ prefix, ... ] \| apply default prefixes?, ... ]	#
`protected`	`INHERITABLE_BY_CLASS_TAGS = [ 'method' => true, 'property' => true, 'property-read' => ['phpstan-', 'psalm-'], 'property-write' => ['phpstan-', 'psalm-'], 'mixin' => true, ]` As above, but for classes inheriting from an interface or trait As above, but for classes inheriting from an interface or trait	#
`protected`	`MERGED_TAGS = ['param' => true, 'return' => true, 'var' => true, 'method' => true, 'property' => true]`	#
`protected`	`STANDARD_TAGS = [ 'param', 'return', 'throws', 'var', 'template', 'template-covariant', 'template-contravariant', 'api', 'internal', 'inheritDoc', 'readonly', ]`	#

Properties
`protected`	`?string`	`$Summary = null`	#
`protected`	`?string`	`$Description = null`	#
`protected`	`array<string, AbstractTag[]>`	`$Tags = []`	#
`protected`	`array<string, ParamTag>`	`$Params = []`	#
`protected`	`?ReturnTag`	`$Return = null`	#
`protected`	`VarTag[]`	`$Vars = []`	#
`protected`	`array<string, MethodTag>`	`$Methods = []`	#
`protected`	`array<string, PropertyTag>`	`$Properties = []`	#
`protected`	`array<string, TemplateTag>`	`$Templates = []`	#
`protected`	`array<class-string, array<string, TemplateTag>>`	`$InheritedTemplates = []`	#
`protected`	`ErrorTag[]`	`$Errors = []`	#
`protected`	`class-string\|null`	`$Class`	#
`protected`	`?string`	`$Member`	#
`protected`	`class-string\|null`	`$Static`	#
`protected`	`class-string\|null`	`$Self`	#
`protected`	`static`	`$Original`	#

Namespaces

Class Salient\PHPDoc\PHPDoc

Implements

Parameters