ArgumentDescriptor
Descriptor representing a single Argument of a method or function.
Interfaces, Classes & Used Traits
- ArgumentInterface
- Describes the public interface for a descriptor of an Argument.
Properties
$fqsen inherited
protected$fqsen : \phpDocumentor\Reflection\Fqsen
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$name inherited
protected$name : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$namespace inherited
protected$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$package inherited
protected$package : \phpDocumentor\Descriptor\PackageDescriptor
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$summary inherited
protected$summary : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$description inherited
protected$description : string
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$fileDescriptor inherited
protected$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$line inherited
protected$line : int
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$tags inherited
protected$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$errors inherited
protected$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$inheritedElement inherited
protected$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
$method Line 28
protected$method : \phpDocumentor\Descriptor\MethodDescriptor
$type Line 31
protected$type : \phpDocumentor\Reflection\Type|null
$default Line 34
protected$default : string|null
$byReference Line 37
protected$byReference : bool
$isVariadic Line 40
protected$isVariadic : bool
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
setNamespace() inherited
Sets the namespace (name) for this element.
publicsetNamespace(NamespaceDescriptor|string $namespace) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getNamespace() inherited
Returns the namespace for this element (defaults to global "\")
publicgetNamespace() : NamespaceDescriptor|string
setSummary() inherited
Sets the summary describing this element in short.
publicsetSummary(string $summary) : void
getSummary() inherited
Returns the summary which describes this element.
publicgetSummary() : string
This method will automatically attempt to inherit the parent's summary if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setDescription() inherited
Sets a description for this element.
publicsetDescription(string $description) : void
getDescription() inherited
Returns the description for this element.
publicgetDescription() : string
This method will automatically attempt to inherit the parent's description if this one has none.
Returns
string —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setLocation() inherited
Sets the file and linenumber where this element is at.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getPath() inherited
Returns the path to the file containing this element relative to the project's root.
publicgetPath() : string
getFile() inherited
Returns the file in which this element resides or null in case the element is not bound to a file.
publicgetFile() : FileDescriptor|null
setFile() inherited
Sets the file to which this element is associated.
publicsetFile(FileDescriptor $file) : void
getLine() inherited
Returns the line number where the definition for this element can be found.
publicgetLine() : int
setLine() inherited
Sets the line number for this element's location in the source file.
publicsetLine(int $lineNumber) : void
setTags() inherited
Sets the tags associated with this element.
publicsetTags(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> $tags) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getTags() inherited
Returns the tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setPackage() inherited
Sets the name of the package to which this element belongs.
publicsetPackage(PackageDescriptor|string $package) : void
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getPackage() inherited
Returns the package name for this element.
publicgetPackage() : PackageDescriptor|null
getAuthor() inherited
publicgetAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getVersion() inherited
Returns the versions for this element.
publicgetVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getCopyright() inherited
Returns the copyrights for this element.
publicgetCopyright() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
setErrors() inherited
Sets a list of all errors associated with this element.
publicsetErrors(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> $errors) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
getErrors() inherited
Returns all errors that occur in this element.
publicgetErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__call() inherited
Dynamically constructs a set of getters to retrieve tag (collections) with.
public__call(string $name, array $arguments) : Collection|mixed|null
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.
- Inherited from
- \phpDocumentor\Descriptor\DescriptorAbstract
__toString() inherited
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
public__toString() : string
getInheritedElement() Line 79
publicgetInheritedElement() : DescriptorAbstract|string|Fqsen|null
setMethod() Line 45
To which method does this argument belong to
publicsetMethod(MethodDescriptor $method) : void
getMethod() Line 50
publicgetMethod() : MethodDescriptor|null
setType() Line 55
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 —
getTypes() Line 72
publicgetTypes() : \phpDocumentor\Descriptor\list\phpDocumentor\Reflection\Type>
Returns
\phpDocumentor\Descriptor\list\phpDocumentor\Reflection\Type> —
setDefault() Line 95
Sets the default value for an argument expressed as a string.
publicsetDefault(string|null $value) : void
Parameters
A textual representation of the default value.
getDefault() Line 100
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 108
Sets whether this argument passes its parameter by reference or by value.
publicsetByReference(mixed $byReference) : void
Parameters
True if the parameter is passed by reference, otherwise it is by value.
isByReference() Line 113
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.
setVariadic() Line 121
Sets whether this argument represents a variadic argument.
publicsetVariadic(bool $isVariadic) : void
Parameters
isVariadic() Line 129
Returns whether this argument represents a variadic argument.
publicisVariadic() : bool