\phpDocumentor\DescriptorArgumentDescriptor

Descriptor representing a single Argument of a method or function.

Summary

Methods

Properties

Constants

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

No public properties found

No constants found

No protected methods found

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

N/A

No private methods found

No private properties found

N/A

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

\phpDocumentor\Descriptor\ArgumentDescriptor
Implements: \phpDocumentor\Descriptor\Interfaces\ArgumentInterface

Properties

$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 — The local name for this element

$namespace

$namespace : \phpDocumentor\Descriptor\NamespaceDescriptor|string

Type

NamespaceDescriptor|string — The namespace for this element

$package

$package : \phpDocumentor\Descriptor\PackageDescriptor|string

Type

PackageDescriptor|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|null

Type

DescriptionDescriptor|null — A more extensive description of this element.

$fileDescriptor

$fileDescriptor : \phpDocumentor\Descriptor\FileDescriptor|null

Type

FileDescriptor|null — The file to which this element belongs; if applicable

$line

$line : int

Type

int — The line number on which this element occurs.

$tags

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

Type

TagDescriptor>> — The tags associated with this element.

$errors

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

Type

Error> — A list of errors found while building this element.

$inheritedElement

$inheritedElement : \phpDocumentor\Descriptor\DescriptorAbstract|null

Type

DescriptorAbstract|null — the element from which to inherit information in this element

$method

$method : \phpDocumentor\Descriptor\MethodDescriptor

Type

MethodDescriptor —

$type

$type : \phpDocumentor\Reflection\Type|null

Type

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 : bool

Type

bool — whether the argument passes the parameter by reference instead of by value

$isVariadic

$isVariadic : bool

Type

bool — Determines if this Argument represents a variadic argument

Methods

__construct()

__construct() : mixed

Initializes this descriptor.

Returns

mixed —

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 local name for this element.

Returns

string —

getNamespace()

getNamespace() : \phpDocumentor\Descriptor\NamespaceDescriptor|string

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

Returns

\phpDocumentor\Descriptor\NamespaceDescriptor|string —

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 —

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 —

getPath()

getPath() : string

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

Returns

string —

getFile()

getFile() : ?\phpDocumentor\Descriptor\FileDescriptor

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

Returns

?\phpDocumentor\Descriptor\FileDescriptor —

getLine()

getLine() : int

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

Returns

int —

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>> —

getPackage()

getPackage() : ?\phpDocumentor\Descriptor\PackageDescriptor

Returns the package name for this element.

Returns

?\phpDocumentor\Descriptor\PackageDescriptor —

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 —

getErrors()

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

Returns all errors that occur in this element.

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 —

getInheritedElement()

getInheritedElement() : \phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null

Returns

\phpDocumentor\Descriptor\DescriptorAbstract|string|\phpDocumentor\Reflection\Fqsen|null —

setMethod()

setMethod(\phpDocumentor\Descriptor\MethodDescriptor  $method) : void

To which method does this argument belong to

Parameters

\phpDocumentor\Descriptor\MethodDescriptor

$method

getMethod()

getMethod() : ?\phpDocumentor\Descriptor\MethodDescriptor

Returns

?\phpDocumentor\Descriptor\MethodDescriptor —

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

?\phpDocumentor\Reflection\Type

$type

Type of this agument represented as a reflection type.

getType()

getType() : ?\phpDocumentor\Reflection\Type

Returns a normalized Types.

Returns

?\phpDocumentor\Reflection\Type —

getTypes()

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

Returns

\phpDocumentor\Descriptor\list<\phpDocumentor\Reflection\Type> —

setDefault()

setDefault(?string  $value) : void

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

Parameters

?string

$value

A textual representation of the default value.

getDefault()

getDefault() : string|null

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

Returns

string|null —

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

setByReference()

setByReference(bool  $byReference) : void

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

Parameters

bool

$byReference

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

isByReference()

isByReference() : bool

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

Returns

bool —

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

setVariadic()

setVariadic(bool  $isVariadic) : void

Sets whether this argument represents a variadic argument.

Parameters

bool

$isVariadic

isVariadic()

isVariadic() : bool

Returns whether this argument represents a variadic argument.

Returns

bool —