Methods

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(string  $name) : void

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

Parameters

string $name

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : string

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

Returns

string

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

string $name

getName()

getName() : string

Returns the local name for this element.

Returns

string

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a longer description for this element.

Parameters

string $description

getDescription()

getDescription() : string

Returns a longer description for this element.

Returns

string

setLocation()

setLocation(\phpDocumentor\Descriptor\FileDescriptor  $file, integer  $line) : void

Sets the file and location for this element.

Parameters

\phpDocumentor\Descriptor\FileDescriptor $file
integer $line

getPath()

getPath() : string

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

Returns

string

getLine()

getLine() : integer

Returns the line number where this element may be found.

Returns

integer

setAbstract()

setAbstract(boolean  $abstract) : void

Parameters

boolean $abstract

isAbstract()

isAbstract() : boolean

Returns

boolean

setFinal()

setFinal(boolean  $final) : void

Parameters

boolean $final

isFinal()

isFinal() : boolean

Returns

boolean

setStatic()

setStatic(boolean  $static) : void

Parameters

boolean $static

isStatic()

isStatic() : boolean

Returns

boolean

setVisibility()

setVisibility(string  $visibility) : void

Parameters

string $visibility