ElementInterface

in package

Represents the public interface to which all descriptors should be held.

Methods

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

publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void

Parameters

$name : Fqsen

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

publicgetFullyQualifiedStructuralElementName() : Fqsen|null

Returns

Fqsen|null

Sets the local name for this element.

publicsetName(string $name) : void

Parameters

$name : string

Returns the local name for this element.

publicgetName() : string

Returns

string

Sets a summary describing this element.

publicsetSummary(string $summary) : void

Parameters

$summary : string

Returns the summary describing this element.

publicgetSummary() : string

Returns

string

Sets a longer description for this element.

publicsetDescription(string $description) : void

Parameters

$description : string

Returns a longer description for this element.

publicgetDescription() : string

Returns

string

Sets the file and location for this element.

publicsetLocation(FileDescriptor $file, int $line) : void

Parameters

$file : FileDescriptor
$line : int

Returns the file location for this element relative to the project root.

publicgetPath() : string

Returns

string

Returns the line number where this element may be found.

publicgetLine() : int

Returns

int
see
getPath()

to find out in which file this element is found.

Returns all tags associated with this element.

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

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>