DescriptorAbstract
Base class for descriptors containing the most used options.
Interfaces, Classes & Used Traits
- Filterable
- Interface to determine which elements can be filtered and to provide a way to set errors on the descriptor.
Properties
$fqsen Line 32
protected$fqsen : \phpDocumentor\Reflection\Fqsen
$name Line 35
protected$name : string
$namespace Line 38
protected$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string
$package Line 41
protected$package : \phpDocumentor\Descriptor\PackageDescriptor
$summary Line 44
protected$summary : string
$description Line 47
protected$description : string
$fileDescriptor Line 50
protected$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
$line Line 53
protected$line : int
$tags Line 56
protected$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
$errors Line 59
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
$inheritedElement Line 62
protected$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
Methods
Returns
mixed —
setFullyQualifiedStructuralElementName() Line 76
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
getFullyQualifiedStructuralElementName() Line 84
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
Returns
Fqsen|null —Parameters
Returns
string —
setNamespace() Line 110
Sets the namespace (name) for this element.
publicsetNamespace(NamespaceDescriptor|string $namespace) : void
getNamespace() Line 120
Returns the namespace for this element (defaults to global "\")
publicgetNamespace() : NamespaceDescriptor|string
setSummary() Line 128
Sets the summary describing this element in short.
publicsetSummary(string $summary) : void
Parameters
This method will automatically attempt to inherit the parent's summary if this one has none.
Returns
string —
setDescription() Line 155
Sets a description for this element.
publicsetDescription(string $description) : void
Parameters
This method will automatically attempt to inherit the parent's description if this one has none.
Returns
string —
setLocation() Line 186
Sets the file and linenumber where this element is at.
publicsetLocation(FileDescriptor $file, int $line) : void
getPath() Line 195
Returns the path to the file containing this element relative to the project's root.
publicgetPath() : string
Returns
string —
getFile() Line 203
Returns the file in which this element resides or null in case the element is not bound to a file.
publicgetFile() : FileDescriptor|null
setFile() Line 211
Sets the file to which this element is associated.
publicsetFile(FileDescriptor $file) : void
getLine() Line 219
Returns the line number where the definition for this element can be found.
publicgetLine() : int
Returns
int —
setLine() Line 227
Sets the line number for this element's location in the source file.
publicsetLine(int $lineNumber) : void
Parameters
setTags() Line 237
Sets the tags associated with this element.
publicsetTags(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> $tags) : void
Parameters
getTags() Line 247
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>> —
setPackage() Line 257
Sets the name of the package to which this element belongs.
publicsetPackage(PackageDescriptor|string $package) : void
getPackage() Line 265
Returns the package name for this element.
publicgetPackage() : PackageDescriptor|null
getAuthor() Line 283
publicgetAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —
getVersion() Line 304
Returns the versions for this element.
publicgetVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —
getCopyright() Line 325
Returns the copyrights for this element.
publicgetCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —Returns
bool —
setErrors() Line 354
Sets a list of all errors associated with this element.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
getErrors() Line 364
Returns all errors that occur in this element.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —
__call() Line 387
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.
__toString() Line 402
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
public__toString() : string