abstract class `Element`

Base class for all structural elements.

Provides properties and methods common to all structural elements.

Namespace	BeastBytes\CodPhp\Element
Inheritance	BeastBytes\CodPhp\Element\Element
Subclasses	BeastBytes\CodPhp\Element\ClassConstantElement BeastBytes\CodPhp\Element\ClassElement BeastBytes\CodPhp\Element\EnumCaseElement BeastBytes\CodPhp\Element\EnumElement BeastBytes\CodPhp\Element\InterfaceElement BeastBytes\CodPhp\Element\MethodElement BeastBytes\CodPhp\Element\ObjectElement BeastBytes\CodPhp\Element\ParameterElement BeastBytes\CodPhp\Element\PropertyElement BeastBytes\CodPhp\Element\TraitElement

Properties

$copyright

Element copyright or null if the element does not have a @copyright tag.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

hasTag()

$deprecationNotice

Element deprecation notice or null if the element does not have a @deprecated tag.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

hasTag()

$description

Element description or null if the element does not have a description.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

$hasDescription

$elementType

Type of element.

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\Element

$hasDescription

true if the element has a description, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

$description

$hasDocBlock

true if the element has a docBlock, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

$docBlock

$hasSummary

true if the element has a summary, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

$summary

$isInApi

true if the element is in the API, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

$linkTags

@link tags normalised to Link objects.

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\Element

Link

$name

Name of the element.

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\Element

$namespace

Namespace of the element.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

$rootNamespace

Root namespace being documented.

Type	Read/Write	Default
string	Read/Write

Declared in BeastBytes\CodPhp\Element\Element

$seeTags

@see tags normalised to Link objects.

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\Element

Link

$since

Content of the element's @since tag, or null if the element does not have a @since tag.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

hasTag

$summary

Element summary or null if the element does not have a summary.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

$hasDobBlock

$version

Content of the element's @version tag, or null if the element does not have a @version tag.

Type	Read/Write	Default
string\|null	Read

Declared in BeastBytes\CodPhp\Element\Element

hasTag

Methods

getElements()

Returns object elements, optionally filtered by element type.

public function getElements(string\|null $type = null): array
$type	string\|null	Type (FQCN) of element to return; `null` returns all elements.
return	array	Object elements.

Declared in BeastBytes\CodPhp\Element\Element

getTag()

Returns the content of the specifies tag or null if the element does not have the specified tag.

public function getTag(string $name): string\|null
$name	string	Name of the tag.
return	string\|null	Content of the specifies tag or `null` if the element does not have the specified tag.

Declared in BeastBytes\CodPhp\Element\Element

hasTag()

Returns a value indicating whether the element has the specified tag.

public function hasTag(string $name): bool
$name	string	Name of the tag.
return	bool	`true` if the element has the specified tag, `false` if not.

Declared in BeastBytes\CodPhp\Element\Element

Generated by CodPhp