Properties

$children

$children : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>

Type

NamespaceDescriptor>

$functions

$functions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>

Type

FunctionDescriptor>

$constants

$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>

Type

ConstantDescriptor>

$classes

$classes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>

Type

ClassDescriptor>

$interfaces

$interfaces : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>

Type

InterfaceDescriptor>

$traits

$traits : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>

Type

TraitDescriptor>

$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

Methods

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

mixed —

setParent()

setParent(mixed  $parent) : void

Sets the parent namespace for this namespace.

{@inheritDoc}

Parameters

mixed $parent

getParent()

getParent() : ?\phpDocumentor\Descriptor\NamespaceDescriptor

Returns the parent namespace for this namespace.

Returns

?\phpDocumentor\Descriptor\NamespaceDescriptor —

setClasses()

setClasses(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>  $classes) : void

Sets a list of all classes in this project.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor> $classes

getClasses()

getClasses() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>

Returns a list of all classes in this namespace.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor> —

setConstants()

setConstants(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>  $constants) : void

Sets a list of all constants in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> $constants

getConstants()

getConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>

Returns a list of all constants in this namespace.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> —

setFunctions()

setFunctions(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>  $functions) : void

Sets a list of all functions in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor> $functions

getFunctions()

getFunctions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>

Returns a list of all functions in this namespace.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor> —

setInterfaces()

setInterfaces(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>  $interfaces) : void

Sets a list of all interfaces in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor> $interfaces

getInterfaces()

getInterfaces() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>

Returns a list of all interfaces in this namespace.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor> —

addChild()

addChild(\phpDocumentor\Descriptor\NamespaceDescriptor  $namespaceDescriptor) : void

Parameters

\phpDocumentor\Descriptor\NamespaceDescriptor $namespaceDescriptor

setChildren()

setChildren(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>  $children) : void

Sets a list of all child namespaces in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor> $children

getChildren()

getChildren() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>

Returns a list of all namespaces contained in this namespace and its children.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor> —

setTraits()

setTraits(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>  $traits) : void

Sets a list of all traits contained in this namespace.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor> $traits

getTraits()

getTraits() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>

Returns a list of all traits in this namespace.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor> —

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 in which this element resides or null in case the element is not bound to a file.

.

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

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