Documentation

ElementInterface
in

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

Table of Contents

getDescription()  : DescriptionDescriptor|null
Returns a longer description for this element.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getPath()  : string
Returns the file location for this element relative to the project root.
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns all tags associated with this element.
setDescription()  : void
Sets a longer description for this element.
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setLocation()  : void
Sets the file and location for this element.
setName()  : void
Sets the local name for this element.
setSummary()  : void
Sets a summary describing this element.

Methods

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 this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int —

getName()

Returns the local name for this element.

public getName() : string
Return values
string —

getPath()

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

public getPath() : string
Return values
string —

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string —

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen
Return values
void —

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string
Return values
void —

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string
Return values
void —

Search results