PackageDescriptor
Represents the package for a class, trait, interface or file.
Interfaces, Classes & Used Traits
- PackageInterface
- Describes the public interface for a package descriptor.
Properties
$parent inherited
protected$parent : \phpDocumentor\Descriptor\NamespaceDescriptor|null
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$children inherited
protected$children : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$functions inherited
protected$functions : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$constants inherited
protected$constants : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$classes inherited
protected$classes : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$interfaces inherited
protected$interfaces : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$traits inherited
protected$traits : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
$fqsen inherited
protected$fqsen : \phpDocumentor\Reflection\Fqsen
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$name inherited
protected$name : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$namespace inherited
protected$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$package inherited
protected$package : \phpDocumentor\Descriptor\PackageDescriptor
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$summary inherited
protected$summary : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$description inherited
protected$description : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$fileDescriptor inherited
protected$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$line inherited
protected$line : int
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$tags inherited
protected$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$errors inherited
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$inheritedElement inherited
protected$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
Methods
setParent() inherited
Sets the parent namespace for this namespace.
publicsetParent(NamespaceDescriptor|null $parent) : void
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getParent() inherited
Returns the parent namespace for this namespace.
publicgetParent() : NamespaceDescriptor|null
setClasses() inherited
Sets a list of all classes in this project.
publicsetClasses(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor> $classes) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getClasses() inherited
Returns a list of all classes in this namespace.
publicgetClasses() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ClassDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setConstants() inherited
Sets a list of all constants in this namespace.
publicsetConstants(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> $constants) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getConstants() inherited
Returns a list of all constants in this namespace.
publicgetConstants() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\ConstantDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setFunctions() inherited
Sets a list of all functions in this namespace.
publicsetFunctions(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor> $functions) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getFunctions() inherited
Returns a list of all functions in this namespace.
publicgetFunctions() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\FunctionDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setInterfaces() inherited
Sets a list of all interfaces in this namespace.
publicsetInterfaces(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor> $interfaces) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getInterfaces() inherited
Returns a list of all interfaces in this namespace.
publicgetInterfaces() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\InterfaceDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setChildren() inherited
Sets a list of all child namespaces in this namespace.
publicsetChildren(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor> $children) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getChildren() inherited
Returns a list of all namespaces contained in this namespace and its children.
publicgetChildren() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\NamespaceDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setTraits() inherited
Sets a list of all traits contained in this namespace.
publicsetTraits(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor> $traits) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
getTraits() inherited
Returns a list of all traits in this namespace.
publicgetTraits() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TraitDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\NamespaceDescriptor
setFullyQualifiedStructuralElementName() inherited
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
getFullyQualifiedStructuralElementName() inherited
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
setNamespace() inherited
Sets the namespace (name) for this element.
publicsetNamespace(NamespaceDescriptor|string $namespace) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getNamespace() inherited
Returns the namespace for this element (defaults to global "\")
publicgetNamespace() : NamespaceDescriptor|string
setSummary() inherited
Sets the summary describing this element in short.
publicsetSummary(string $summary) : void
getSummary() inherited
Returns the summary which describes this element.
publicgetSummary() : string
This method will automatically attempt to inherit the parent's summary if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setDescription() inherited
Sets a description for this element.
publicsetDescription(string $description) : void
getDescription() inherited
Returns the description for this element.
publicgetDescription() : string
This method will automatically attempt to inherit the parent's description if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setLocation() inherited
Sets the file and linenumber where this element is at.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getPath() inherited
Returns the path to the file containing this element relative to the project's root.
publicgetPath() : string
getFile() inherited
Returns the file in which this element resides or null in case the element is not bound to a file.
publicgetFile() : FileDescriptor|null
setFile() inherited
Sets the file to which this element is associated.
publicsetFile(FileDescriptor $file) : void
getLine() inherited
Returns the line number where the definition for this element can be found.
publicgetLine() : int
setLine() inherited
Sets the line number for this element's location in the source file.
publicsetLine(int $lineNumber) : void
setTags() inherited
Sets the tags associated with this element.
publicsetTags(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> $tags) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getTags() inherited
Returns the tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setPackage() inherited
Sets the name of the package to which this element belongs.
publicsetPackage(PackageDescriptor|string $package) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getPackage() inherited
Returns the package name for this element.
publicgetPackage() : PackageDescriptor|null
getAuthor() inherited
publicgetAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getVersion() inherited
Returns the versions for this element.
publicgetVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getCopyright() inherited
Returns the copyrights for this element.
publicgetCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setErrors() inherited
Sets a list of all errors associated with this element.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getErrors() inherited
Returns all errors that occur in this element.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__call() inherited
Dynamically constructs a set of getters to retrieve tag (collections) with.
public__call(string $name, array $arguments) : Collection|mixed|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.
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__toString() inherited
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
public__toString() : string
getInheritedElement() inherited
publicgetInheritedElement() : DescriptorAbstract|string|Fqsen|null
Returns
DescriptorAbstract|string|Fqsen|null —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract