\phpDocumentor\DescriptorPackageDescriptor

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

setParent()

setParent(mixed  $parent) : void

Sets the parent namespace for this namespace.

{@inheritDoc}

Parameters

getParent()

getParent() : ?\phpDocumentor\Descriptor\Interfaces\NamespaceInterface

Returns the parent namespace for this namespace.

Returns

setClasses()

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

Sets a list of all classes in this project.

Parameters

getClasses()

getClasses() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ClassInterface>

Returns a list of all classes in this namespace.

Returns

setConstants()

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

Sets a list of all constants in this namespace.

Parameters

getConstants()

getConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\ConstantInterface>

Returns a list of all constants in this namespace.

Returns

setFunctions()

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

Sets a list of all functions in this namespace.

Parameters

getFunctions()

getFunctions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\FunctionInterface>

Returns a list of all functions in this namespace.

Returns

setInterfaces()

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

Sets a list of all interfaces in this namespace.

Parameters

getInterfaces()

getInterfaces() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\InterfaceInterface>

Returns a list of all interfaces in this namespace.

Returns

addChild()

addChild(\phpDocumentor\Descriptor\Interfaces\NamespaceInterface  $namespaceDescriptor) : void

Parameters

setChildren()

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

Sets a list of all child namespaces in this namespace.

Parameters

getChildren()

getChildren() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\NamespaceInterface>

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

Returns

setTraits()

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

Sets a list of all traits contained in this namespace.

Parameters

getTraits()

getTraits() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\TraitInterface>

Returns a list of all traits in this namespace.

Returns

getEnums()

getEnums() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface>

Returns a list of all enums in this namespace.

Returns

setEnums()

setEnums(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Interfaces\EnumInterface>  $enums) : void

Sets a list of all enums contained in this namespace.

Parameters

getErrors()

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

Returns all errors associated with this tag.

Returns

__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

Returns

__toString()

__toString() : string

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

Returns

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

getName()

getName() : string

Returns the name for this element.

Returns

getNamespace()

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

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

Returns

getPackage()

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

Returns the package name for this element.

Returns

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

setDescription()

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

Sets a description or none to inherit from a parent.

Parameters

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

getTags()

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

Returns the tags associated with this element.

Returns

getAuthor()

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

Returns

getVersion()

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

Returns the versions for this element.

Returns

getCopyright()

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

Returns the copyrights for this element.

Returns

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

getPath()

getPath() : string

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

Returns

getFile()

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

Returns the file in which this element resides or null in case the element is not bound to a file.

.

Returns

getLine()

getLine() : int

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

Returns

getStartLocation()

getStartLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

getInheritedElement()

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

Returns the element from which this element inherits, or null if it doesn't inherit any information.

This method is usually overridden in consuming classes with the determination how that class should resolve inheritance. This is a placeholder function for those classes who need a simple way to provide inheritance.

Returns