ArgumentInterface

extends ElementInterface
in package

Describes the public interface for a descriptor of an Argument.

ArgumentInterface.php
Parents
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Methods

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

publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void

Parameters

$name : Fqsen
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

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

publicgetFullyQualifiedStructuralElementName() : Fqsen|null

Returns

Fqsen|null —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets the local name for this element.

publicsetName(string $name) : void

Parameters

$name : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the local name for this element.

publicgetName() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets a summary describing this element.

publicsetSummary(string $summary) : void

Parameters

$summary : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the summary describing this element.

publicgetSummary() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets a longer description for this element.

publicsetDescription(string $description) : void

Parameters

$description : string
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns a longer description for this element.

publicgetDescription() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets the file and location for this element.

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

Parameters

$file : FileDescriptor
$line : int
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

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

publicgetPath() : string

Returns

string —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Returns the line number where this element may be found.

publicgetLine() : int

Returns

int —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface
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> —
Inherited from
\phpDocumentor\Descriptor\Interfaces\ElementInterface

Sets a normalized list of types that the argument represents.

publicsetType(Type|null $type) : void

Arguments should have one of the types mentioned in this array. If this array is empty than that is considered to be the type mixed (meaning: can be anything).

Any Type representing a class/interface/trait should be normalized to its complete FQCN, including preceding backslash. Types that do not represent a class/interface/trait should be written in lowercaps and should not be preceded by a backslash.

Parameters

$type : Type|null

Type of this agument represented as a reflection type.

link
https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md#appendix-a-types

Definition of a type.

todo

update link to point to the final destination for the PHPDoc Standard.

Returns a normalized Types.

publicgetType() : Type|null

Returns

Type|null —
see
self::setTypes()

for details on what types represent.

Sets the default value for an argument expressed as a string.

publicsetDefault(string $value) : void

Parameters

$value : string

A textual representation of the default value.

Returns the default value for an argument as string or null if no default is set.

publicgetDefault() : string|null

Returns

string|null —

A textual representation of the default value, or null if no default value is present.

Sets whether this argument passes its parameter by reference or by value.

publicsetByReference(bool $byReference) : void

Parameters

$byReference : bool

True if the parameter is passed by reference, otherwise it is by value.

Returns whether the parameter is passed by reference or by value.

publicisByReference() : bool

Returns

bool —

True if the parameter is passed by reference, otherwise it is by value.