ElementInterface
in package
Represents the public interface to which all descriptors should be held.
Methods
setFullyQualifiedStructuralElementName() Line 29
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
getFullyQualifiedStructuralElementName() Line 34
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
Returns
Fqsen|null —Parameters
Returns
string —
setSummary() Line 49
Sets a summary describing this element.
publicsetSummary(string $summary) : void
Parameters
Returns
string —
setDescription() Line 59
Sets a longer description for this element.
publicsetDescription(string $description) : void
Parameters
getDescription() Line 64
Returns a longer description for this element.
publicgetDescription() : string
Returns
string —
setLocation() Line 69
Sets the file and location for this element.
publicsetLocation(FileDescriptor $file, int $line) : void
getPath() Line 74
Returns the file location for this element relative to the project root.
publicgetPath() : string
Returns
string —Returns
int —
getTags() Line 88
Returns all tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>