final class EnumElement

Source Code

Represents an Enum structural element.

Namespace	BeastBytes\CodPhp\Element
Inheritance	BeastBytes\CodPhp\Element\EnumElement BeastBytes\CodPhp\Element\ObjectElement BeastBytes\CodPhp\Element\Element

Properties

$ancestors

Ancestors of the element indexed by FQCN.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$backingType

The Backing type or null if not backed

Type	Read/Write	Default
ReflectionType|null	Read

Declared in BeastBytes\CodPhp\Element\EnumElement

---

$canHaveMethodTag

true if the element can have a @method tag, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$canHavePropertyTag

true if the element can have a @property, @property-read, or @property-write tag, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$cases

Cases

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\EnumElement

---

$constants

Public constants defined in the element. Enum cases are not included - use the cases property.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $hasConstants

---

$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

Related

• 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

Related

• 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

Related

• $hasDescription

---

$elementType

Type of element.

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\Element

---

$fqcn

FQCN of the element's object

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$hasAncestors

true if the element has ancestors, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $ancestors

---

$hasConstants

true if the element has public constants, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $constants

---

$hasDescription

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

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

Related

• $description

---

$hasDocBlock

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

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

Related

• $docBlock

---

$hasMethods

true if the element has methods, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $methods

---

$hasSubclasses

true if the element has subclasses, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $subclasses

---

$hasSummary

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

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\Element

Related

• $summary

---

$implementsInterfaces

true if the element implements interfaces, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$inheritance

The inheritance path for the element; $this and its ancestors.

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$inheritanceLevel

Inheritence level to show.

Type	Read/Write	Default
BeastBytes\CodPhp\InheritanceLevel	Read/Write

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$interfaces

Interfaces implemented by the element.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• InterfaceElement

---

$isBacked

true if the enum is backed, false if not

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\EnumElement

---

$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

Related

• Link

---

$methodTags

Array of @method tags

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$methods

Methods implemented by the element.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $hasMethods

---

$name

Element name.

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$namespace

Object namespace.

Type	Read/Write	Default
string	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$propertyReadTags

Array of @property-read tags

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$propertyTags

Array of @property tags

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$propertyWriteTags

Array of @property-write tags

Type	Read/Write	Default
array	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

$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

Related

• 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

Related

• hasTag

---

$subclasses

Subclasses of the element.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $subclasses

---

$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

Related

• $hasDobBlock

---

$traits

Traits used by the element.

Type	Read/Write	Default
array	Read	[]

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $usesTraits
• TraitElement

---

$usesTraits

true if the element uses traits, false if not.

Type	Read/Write	Default
bool	Read

Declared in BeastBytes\CodPhp\Element\ObjectElement

Related

• $traits

---

$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

Related

• 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

---

hasTag()

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

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

Declared in BeastBytes\CodPhp\Element\Element

---

pathTo()

Returns the relative path from this element to the given element.

public function pathTo(BeastBytes\CodPhp\Element\ObjectElement|string $destination): string|null
$destination	BeastBytes\CodPhp\Element\ObjectElement|string	The FQCN or element to get the path to.
return	string|null	Relative path to the element from this element or `null` if $element is this element.

Declared in BeastBytes\CodPhp\Element\ObjectElement

---

Generated by CodPhp