Properties

$fqsen

$fqsen : string

Type

string — Fully Qualified Structural Element Name; the FQCN including method, property of constant name

$name

$name : string

Type

string — The local name for this element

$package

$package : string

Type

string — The package with which this element is associated

$summary

$summary : string

Type

string — A summary describing the function of this element in short.

$description

$description : string

Type

string — A more extensive description of this element.

$line

$line : integer

Type

integer — The line number on which this element occurs.

$abstract

$abstract : boolean

Type

boolean

$final

$final : boolean

Type

boolean

$static

$static : boolean

Type

boolean

$visibility

$visibility : string

Type

string

Methods

__construct()

__construct() 

Initializes the all properties representing a collection with a new Collection object.

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

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string|null

Returns the namespace for this element or null if none is attached.

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor|string|null

setSummary()

setSummary(string  $summary) : void

Sets the summary describing this element in short.

Parameters

string $summary

getSummary()

getSummary() : string

Returns the summary which describes this element.

This method will automatically attempt to inherit the parent's summary if this one has none.

Returns

string

setDescription()

setDescription(string  $description) : void

Sets a description for this element.

Parameters

string $description

getDescription()

getDescription() : string

Returns the description for this element.

This method will automatically attempt to inherit the parent's description if this one has none.

Returns

string

setLocation()

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

Sets the file and linenumber where this element is at.

Parameters

\phpDocumentor\Descriptor\FileDescriptor $file
integer $line

getPath()

getPath() : string

Returns the path to the file containing this element relative to the project's root.

Returns

string

getLine()

getLine() : integer

Returns the line number where the definition for this element can be found.

Returns

integer

setLine()

setLine(integer  $lineNumber) : void

Sets the line number for this element's location in the source file.

Parameters

integer $lineNumber

isDeprecated()

isDeprecated() : boolean

Checks whether this element is deprecated.

Returns

boolean

setErrors()

setErrors(\phpDocumentor\Descriptor\Collection  $errors) : void

Sets a list of all errors associated with this element.

Parameters

\phpDocumentor\Descriptor\Collection $errors

__call()

__call(string  $name, array<mixed,mixed>  $arguments) : \phpDocumentor\Descriptor\Collection|null

Dynamically constructs a set of getters to retrieve tag (collections) with.

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.

Parameters

string $name
array<mixed,mixed> $arguments

Returns

\phpDocumentor\Descriptor\Collection|null

__toString()

__toString() : string

Represents this object by its unique identifier, the Fully Qualified Structural Element Name.

Returns

string

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\MethodDescriptor|null

Returns the Method from which this method should inherit its information, if any.

The inheritance scheme for a method is more complicated than for most elements; the following business rules apply:

  1. if the parent class/interface extends another class or other interfaces (interfaces have multiple inheritance!) then:
    1. Check each parent class/interface's parent if they have a method with the exact same name
    2. if a method is found with the same name; return the first one encountered.
  2. if the parent is a class and implements interfaces, check each interface for a method with the exact same name. If such a method is found, return the first hit.

Returns

\phpDocumentor\Descriptor\MethodDescriptor|null

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

getVisibility()

getVisibility() : string

Returns the visibility for this element.

The following values are supported:

  • public
  • protected
  • private

Returns

string

setArguments()

setArguments(\phpDocumentor\Descriptor\Collection  $arguments) 

[email protected]}

Parameters

\phpDocumentor\Descriptor\Collection $arguments

getResponse()

getResponse() 

[email protected]}