\phpDocumentor\Descriptor\InterfacesArgumentInterface

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Returns the namespace for this element (defaults to global "\")

Returns

setFullyQualifiedStructuralElementName()

setFullyQualifiedStructuralElementName(\phpDocumentor\Reflection\Fqsen  $name) : void

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

Parameters

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

setSummary()

setSummary(string  $summary) : void

Sets a summary describing this element.

Parameters

getSummary()

getSummary() : string

Returns the summary describing this element.

Returns

setLocation()

setLocation(\phpDocumentor\Descriptor\Interfaces\FileInterface  $file, \phpDocumentor\Reflection\Location  $startLocation) : void

Sets the file and location for this element.

Parameters

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

Returns the end location where the definition for this element can be found.

Returns

getPath()

getPath() : string

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

Returns

getLine()

getLine() : int

Returns the line number where this element may be found.

Returns

getTags()

getTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Returns all tags associated with this element.

Returns

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\Interfaces\PackageInterface

Returns the package name for this element.

Returns

getName()

getName() : string

Returns the local name for this element.

Returns

setName()

setName(string  $name) : void

Sets the local name for this element.

Parameters

getDescription()

getDescription() : \phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Returns the description for this element.

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

Returns

setDescription()

setDescription(\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a longer description for this element.

Parameters

getErrors()

getErrors() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Returns

setType()

setType(?\phpDocumentor\Reflection\Type  $type) : void

Sets a normalized list of types that the argument represents.

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

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns a normalized Types.

Returns

setMethod()

setMethod(\phpDocumentor\Descriptor\Interfaces\MethodInterface  $method) : void

To which method does this argument belong to

Parameters

getMethod()

getMethod() : \phpDocumentor\Descriptor\Interfaces\MethodInterface

Returns

setDefault()

setDefault(string  $value) : void

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

Parameters

getDefault()

getDefault() : string|null

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

Returns

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

setByReference()

setByReference(\phpDocumentor\Descriptor\ValueObjects\IsApplicable  $byReference) : void

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

Parameters

isByReference()

isByReference() : bool

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

Returns

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

setVariadic()

setVariadic(\phpDocumentor\Descriptor\ValueObjects\IsApplicable  $isVariadic) : void

Sets whether this argument represents a variadic argument.

Parameters

isVariadic()

isVariadic() : bool

Returns whether this argument represents a variadic argument.

Returns