Documentation

PackageDescriptor extends NamespaceDescriptor
in package
implements PackageInterface

Represents the package for a class, trait, interface or file.

Interfaces, Classes and Traits

PackageInterface
Describes the public interface for a package descriptor.

Table of Contents

$children  : Collection<string|int, NamespaceDescriptor>
$classes  : Collection<string|int, ClassDescriptor>
$constants  : Collection<string|int, ConstantDescriptor>
$description  : DescriptionDescriptor|null
$errors  : Collection<string|int, Error>
$fileDescriptor  : FileDescriptor|null
$fqsen  : Fqsen
$functions  : Collection<string|int, FunctionDescriptor>
$inheritedElement  : DescriptorAbstract|null
$interfaces  : Collection<string|int, InterfaceDescriptor>
$line  : int
$name  : string
$namespace  : NamespaceDescriptor|string
$package  : PackageDescriptor|string
$parent  : NamespaceDescriptor|null
$summary  : string
$tags  : Collection<string|int, Collection<string|int, TagDescriptor>>
$traits  : Collection<string|int, TraitDescriptor>
__call()  : Collection<string|int, TagDescriptor>|null
Dynamically constructs a set of getters to retrieve tag (collections) with.
__construct()  : mixed
Initializes this descriptor.
__toString()  : string
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
addChild()  : void
getAuthor()  : Collection<string|int, AuthorDescriptor>
getChildren()  : Collection<string|int, NamespaceDescriptor>
Returns a list of all namespaces contained in this namespace and its children.
getClasses()  : Collection<string|int, ClassDescriptor>
Returns a list of all classes in this namespace.
getConstants()  : Collection<string|int, ConstantDescriptor>
Returns a list of all constants in this namespace.
getCopyright()  : Collection<string|int, TagDescriptor>
Returns the copyrights for this element.
getDescription()  : DescriptionDescriptor|null
Returns the description for this element.
getErrors()  : Collection<string|int, Error>
Returns all errors that occur in this element.
getFile()  : FileDescriptor|null
Returns the file in which this element resides or null in case the element is not bound to a file.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getFunctions()  : Collection<string|int, FunctionDescriptor>
Returns a list of all functions in this namespace.
getInheritedElement()  : DescriptorAbstract|string|Fqsen|null
getInterfaces()  : Collection<string|int, InterfaceDescriptor>
Returns a list of all interfaces in this namespace.
getLine()  : int
Returns the line number where the definition for this element can be found.
getName()  : string
Returns the local name for this element.
getNamespace()  : NamespaceDescriptor|string
Returns the namespace for this element (defaults to global "\")
getPackage()  : PackageDescriptor|null
Returns the package name for this element.
getParent()  : NamespaceDescriptor|null
Returns the parent namespace for this namespace.
getPath()  : string
Returns the path to the file containing this element relative to the project's root.
getSummary()  : string
Returns the summary which describes this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns the tags associated with this element.
getTraits()  : Collection<string|int, TraitDescriptor>
Returns a list of all traits in this namespace.
getVersion()  : Collection<string|int, VersionDescriptor>
Returns the versions for this element.
isDeprecated()  : bool
Checks whether this element is deprecated.
setChildren()  : void
Sets a list of all child namespaces in this namespace.
setClasses()  : void
Sets a list of all classes in this project.
setConstants()  : void
Sets a list of all constants in this namespace.
setFunctions()  : void
Sets a list of all functions in this namespace.
setInterfaces()  : void
Sets a list of all interfaces in this namespace.
setParent()  : void
Sets the parent namespace for this namespace.
setTraits()  : void
Sets a list of all traits contained in this namespace.

Properties

$fqsen

protected Fqsen $fqsen

Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$summary

protected string $summary = ''

A summary describing the function of this element in short.

Methods

__call()

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

public __call(string $name, array<string|int, mixed> $arguments) : Collection<string|int, TagDescriptor>|null

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
$name : string
$arguments : array<string|int, mixed>
Return values
Collection<string|int, TagDescriptor>|null —

__construct()

Initializes this descriptor.

public __construct() : mixed
Return values
mixed —

__toString()

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

public __toString() : string
Return values
string —

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null —

getLine()

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

public getLine() : int
Return values
int —

getName()

Returns the local name for this element.

public getName() : string
Return values
string —

getPath()

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

public getPath() : string
Return values
string —

getSummary()

Returns the summary which describes this element.

public getSummary() : string

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

Return values
string —

isDeprecated()

Checks whether this element is deprecated.

public isDeprecated() : bool
Return values
bool —

setParent()

Sets the parent namespace for this namespace.

public setParent(mixed $parent) : void
Parameters
$parent : mixed
Return values
void —

Search results