Methods

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

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

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(\phpDocumentor\Reflection\Fqsen  $name) : void

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

Parameters

\phpDocumentor\Reflection\Fqsen $name

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

string —

setLocation()

setLocation(\phpDocumentor\Descriptor\Interfaces\FileInterface  $file, \phpDocumentor\Reflection\Location  $startLocation) : void

Sets the file and location for this element.

Parameters

\phpDocumentor\Descriptor\Interfaces\FileInterface $file
\phpDocumentor\Reflection\Location $startLocation

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

Returns the end location where the definition for this element can be found.

Returns

?\phpDocumentor\Reflection\Location —

getPath()

getPath() : string

Returns the file location for this element relative to the project root.

Returns

string —

getLine()

getLine() : int

Returns the line number where this element may be found.

Returns

int —

getTags()

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

Returns all tags associated with this element.

Returns

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

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

getName()

getName() : string

Returns the local name for this element.

Returns

string —

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

string $name

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 —

setDescription()

setDescription(\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a longer description for this element.

Parameters

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor $description

getErrors()

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

Returns

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

__toString()

__toString() : string

Returns

string —

setProperties()

setProperties(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface>  $properties) : void

Sets the properties associated with this trait.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface> $properties

getProperties()

getProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface>

Returns the properties associated with this trait.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface> —

getInheritedProperties()

getInheritedProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface>

Returns all properties inherited from parent traits.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\PropertyInterface> —

setMethods()

setMethods(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>  $methods) : void

Sets all methods belonging to this trait.

Parameters

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> $methods

getMethods()

getMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>

Returns all methods belonging to this trait.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> —

getInheritedMethods()

getInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface>

Returns a list of all methods inherited from parent traits.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\MethodInterface> —

getFile()

getFile() : ?\phpDocumentor\Descriptor\Interfaces\FileInterface

Returns the file associated with the parent class or trait.

Returns

?\phpDocumentor\Descriptor\Interfaces\FileInterface —