\phpDocumentor\DescriptorConstantDescriptor

Descriptor representing a constant

Summary

Methods

Properties

Constants

__construct()
getFullyQualifiedStructuralElementName()
getName()
getNamespace()
getSummary()
getDescription()
getPath()
getFile()
getLine()
getTags()
getPackage()
getAuthor()
getVersion()
getCopyright()
isDeprecated()
getErrors()
__call()
__toString()
getInheritedElement()
setParent()
getParent()
setTypes()
getTypes()
getType()
setValue()
getValue()
getVar()
setVisibility()
getVisibility()

No public properties found

No constants found

No protected methods found

$fqsen
$name
$namespace
$package
$summary
$description
$fileDescriptor
$line
$tags
$errors
$inheritedElement
$parent
$types
$value
$visibility

N/A

No private methods found

No private properties found

N/A

File: src/phpDocumentor/Descriptor/ConstantDescriptor.php
Package: phpDocumentor\AST
Class hierarchy: DescriptorAbstract

\phpDocumentor\Descriptor\ConstantDescriptor
Implements: \phpDocumentor\Descriptor\Interfaces\ConstantInterface; \phpDocumentor\Descriptor\Interfaces\VisibilityInterface

Properties

$fqsen

$fqsen : \phpDocumentor\Reflection\Fqsen

Type

\phpDocumentor\Reflection\Fqsen — Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$name

$name : string

Type

string — The local name for this element

$namespace

$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string

Type

NamespaceDescriptor|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\PackageDescriptor|string

Type

PackageDescriptor|string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor|null

Type

DescriptionDescriptor|null — A more extensive description of this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null

Type

FileDescriptor|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$tags

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Type

TagDescriptor>> — The tags associated with this element.

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

Error> — A list of errors found while building this element.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null

Type

DescriptorAbstract|null — the element from which to inherit information in this element

$parent

$parent : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|null

Type

InterfaceDescriptor|null —

$types

$types : \phpDocumentor\Reflection\Type|null

Type

Type|null —

$value

$value : string

Type

string —

$visibility

$visibility : string

Type

string —

Methods

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

mixed —

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

Returns the Fully Qualified Structural Element Name (FQSEN) for this element.

Returns

?\phpDocumentor\Reflection\Fqsen —

getName()

getName() : string

Returns the local name for this element.

Returns

string —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string

Returns the namespace for this element (defaults to global "\")

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor|string —

getSummary()

getSummary() : string

Returns the summary which describes this element.

This method will automatically attempt to inherit the parent's summary if this one has none.

Returns

string —

getDescription()

getDescription() : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getPath()

getPath() : string

Returns the path to the file containing this element relative to the project's root.

Returns

string —

getFile()

getFile() : \phpDocumentor\Descriptor\FileDescriptor

Returns the file associated with the parent class, interface or trait when inside a container.

Returns

\phpDocumentor\Descriptor\FileDescriptor —

getLine()

getLine() : int

Returns the line number where the definition for this element can be found.

Returns

int —

getTags()

getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns the tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\PackageDescriptor

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\PackageDescriptor —

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

getCopyright()

getCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>

Returns the copyrights for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

bool —

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns all errors that occur in this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

__call()

__call(string  $name, array  $arguments) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null

Dynamically constructs a set of getters to retrieve tag (collections) with.

Important: __call() is not a fast method of access; it is preferred to directly use the getTags() collection. This interface is provided to allow for uniform and easy access to certain tags.

Parameters

string	$name
array	$arguments

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null —

__toString()

__toString() : string

Represents this object by its unique identifier, the Fully Qualified Structural Element Name.

Returns

string —

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null

Returns the Constant from which this one should inherit, if any.

Returns

\phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null —

setParent()

setParent(\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|null  $parent) : void

Registers a parent class or interface with this constant.

Parameters

\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|null

$parent

Throws

\InvalidArgumentException: If anything other than a class, interface or null was passed.

getParent()

getParent() : \phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|null

Returns

\phpDocumentor\Descriptor\ClassDescriptor|\phpDocumentor\Descriptor\InterfaceDescriptor|null —

setTypes()

setTypes(\phpDocumentor\Reflection\Type  $types) : void

Sets the types that this constant may contain.

Parameters

\phpDocumentor\Reflection\Type

$types

getTypes()

getTypes() : \phpDocumentor\Descriptor\list<\phpDocumentor\Reflection\Type>

Returns the types that may be present in this constant.

Returns

\phpDocumentor\Descriptor\list<\phpDocumentor\Reflection\Type> —

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns

?\phpDocumentor\Reflection\Type —

setValue()

setValue(string  $value) : void

Sets the value representation for this constant.

Parameters

string

$value

getValue()

getValue() : string

Retrieves a textual representation of the value in this constant.

Returns

string —

getVar()

getVar() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\VarDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\VarDescriptor> —

setVisibility()

setVisibility(string  $visibility) : void

Parameters

string

$visibility

getVisibility()

getVisibility() : string

Returns the visibility for this element.

The following values are supported:

public
protected
private

Returns

string —