\phpDocumentor\DescriptorArgumentDescriptor

Descriptor representing a single Argument of a method or function.

Summary

Methods

Properties

Constants

setMethod()
getMethod()
setType()
getType()
getTypes()
setDefault()
getDefault()
setByReference()
isByReference()
setVariadic()
isVariadic()
__construct()
getErrors()
__call()
__toString()
getFullyQualifiedStructuralElementName()
getName()
getNamespace()
getPackage()
getSummary()
setDescription()
getDescription()
getTags()
getAuthor()
getVersion()
getCopyright()
isDeprecated()
getPath()
getFile()
getLine()
getStartLocation()
getEndLocation()
getInheritedElement()

No public properties found

No constants found

No protected methods found

$type
$default
$byReference
$isVariadic
$fqsen
$name
$namespace
$package
$summary
$description
$tags
$fileDescriptor
$line
$startLocation
$endLocation
$errors
$inheritedElement

N/A

No private methods found

$method

N/A

File: src/phpDocumentor/Descriptor/ArgumentDescriptor.php
Package: phpDocumentor\AST
Class hierarchy: DescriptorAbstract

\phpDocumentor\Descriptor\ArgumentDescriptor
Implements: \phpDocumentor\Descriptor\Interfaces\ArgumentInterface
Uses traits: \phpDocumentor\Descriptor\Traits\BelongsToMethod; \phpDocumentor\Descriptor\Traits\CanHaveAType; \phpDocumentor\Descriptor\Traits\CanHaveADefaultValue; \phpDocumentor\Descriptor\Traits\CanBeByReference; \phpDocumentor\Descriptor\Traits\CanBeVariadic
Uses

Properties

$type

$type : \phpDocumentor\Reflection\Type|null

Type

\phpDocumentor\Reflection\Type|null — normalized type of this argument

$default

$default : string|null

Type

string|null — the default value for an argument or null if none is provided

$byReference

$byReference : \phpDocumentor\Descriptor\ValueObjects\IsApplicable

Type

\phpDocumentor\Descriptor\ValueObjects\IsApplicable — whether the argument passes the parameter by reference instead of by value

$isVariadic

$isVariadic : \phpDocumentor\Descriptor\ValueObjects\IsApplicable

Type

\phpDocumentor\Descriptor\ValueObjects\IsApplicable — Determines if this Argument represents a variadic argument

$fqsen

$fqsen : ?\phpDocumentor\Reflection\Fqsen

Type

?\phpDocumentor\Reflection\Fqsen — Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$name

$name : string

Type

string

$namespace

$namespace : \phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\Interfaces\PackageInterface|string

Type

\phpDocumentor\Descriptor\Interfaces\PackageInterface|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 : ?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

Type

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$tags

$tags : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> — The tags associated with this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\Interfaces\FileInterface|null

Type

\phpDocumentor\Descriptor\Interfaces\FileInterface|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$startLocation

$startLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$endLocation

$endLocation : ?\phpDocumentor\Reflection\Location

Type

?\phpDocumentor\Reflection\Location

$errors

$errors : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error>

Type

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> — A collection of errors found during filtering.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null

Type

\phpDocumentor\Descriptor\Interfaces\ElementInterface|string|\phpDocumentor\Reflection\Fqsen|null — the element from which to inherit information in this element

$method

$method : \phpDocumentor\Descriptor\Interfaces\MethodInterface

Type

\phpDocumentor\Descriptor\Interfaces\MethodInterface

Methods

setMethod()

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

To which method does this argument belong to

Parameters

\phpDocumentor\Descriptor\Interfaces\MethodInterface

$method

getMethod()

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

Returns

\phpDocumentor\Descriptor\Interfaces\MethodInterface —

setType()

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

Parameters

?\phpDocumentor\Reflection\Type

$type

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns

?\phpDocumentor\Reflection\Type —

getTypes()

getTypes() : list<\phpDocumentor\Reflection\Type>

Returns

list<\phpDocumentor\Reflection\Type> —

setDefault()

setDefault(?string  $value) : void

Parameters

?string

$value

getDefault()

getDefault() : ?string

Returns

?string —

setByReference()

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

Parameters

\phpDocumentor\Descriptor\ValueObjects\IsApplicable

$byReference

isByReference()

isByReference() : bool

Returns

bool —

setVariadic()

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

Sets whether this argument represents a variadic argument.

Parameters

\phpDocumentor\Descriptor\ValueObjects\IsApplicable

$isVariadic

isVariadic()

isVariadic() : bool

Returns whether this argument represents a variadic argument.

Returns

bool —

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

mixed —

getErrors()

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

Returns all errors associated with this tag.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Validation\Error> —

__call()

__call(string  $name, array  $arguments) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|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	$arguments

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>|null —

__toString()

__toString() : string

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

Returns

string —

getFullyQualifiedStructuralElementName()

getFullyQualifiedStructuralElementName() : ?\phpDocumentor\Reflection\Fqsen

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

Returns

?\phpDocumentor\Reflection\Fqsen —

getName()

getName() : string

Returns the name for this element.

Returns

string —

getNamespace()

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

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

Returns

\phpDocumentor\Descriptor\Interfaces\NamespaceInterface|string —

getPackage()

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

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\Interfaces\PackageInterface —

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(?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor  $description) : void

Sets a description or none to inherit from a parent.

Parameters

?\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor

$description

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

\phpDocumentor\Descriptor\DocBlock\DescriptionDescriptor —

getTags()

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

Returns the tags associated with this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>> —

getAuthor()

getAuthor() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor>

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\Tag\AuthorDescriptor> —

getVersion()

getVersion() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor>

Returns the versions for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\VersionDescriptor> —

getCopyright()

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

Returns the copyrights for this element.

Returns

\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —

isDeprecated()

isDeprecated() : bool

Checks whether this element is deprecated.

Returns

bool —

getPath()

getPath() : string

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

Returns

string —

getFile()

getFile() : ?\phpDocumentor\Descriptor\Interfaces\FileInterface

Returns the file in which this element resides or null in case the element is not bound to a file.

Returns

?\phpDocumentor\Descriptor\Interfaces\FileInterface —

getLine()

getLine() : int

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

Returns

int —

getStartLocation()

getStartLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getEndLocation()

getEndLocation() : ?\phpDocumentor\Reflection\Location

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

Returns

?\phpDocumentor\Reflection\Location —

getInheritedElement()

getInheritedElement() : ?\phpDocumentor\Descriptor\Interfaces\ArgumentInterface

Returns

?\phpDocumentor\Descriptor\Interfaces\ArgumentInterface —