ArgumentInterface
extends ElementInterfaceDescribes the public interface for a descriptor of an Argument.
Methods
setFullyQualifiedStructuralElementName() inherited
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
getFullyQualifiedStructuralElementName() inherited
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
setSummary() inherited
Sets a summary describing this element.
publicsetSummary(string $summary) : void
setDescription() inherited
Sets a longer description for this element.
publicsetDescription(string $description) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getDescription() inherited
Returns a longer description for this element.
publicgetDescription() : string
setLocation() inherited
Sets the file and location for this element.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getPath() inherited
Returns the file location for this element relative to the project root.
publicgetPath() : string
getTags() inherited
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
setType() Line 40
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 of this agument represented as a reflection type.
Returns
Type|null —
setDefault() Line 54
Sets the default value for an argument expressed as a string.
publicsetDefault(string $value) : void
Parameters
A textual representation of the default value.
getDefault() Line 61
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.
setByReference() Line 68
Sets whether this argument passes its parameter by reference or by value.
publicsetByReference(bool $byReference) : void
Parameters
True if the parameter is passed by reference, otherwise it is by value.
isByReference() Line 75
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.