phpDocumentor

ArgumentDescriptor extends DescriptorAbstract
in package
implements ArgumentInterface uses BelongsToMethod, CanHaveAType, CanHaveADefaultValue, CanBeByReference, CanBeVariadic

Descriptor representing a single Argument of a method or function.

Table of Contents

Interfaces

ArgumentInterface
Describes the public interface for a descriptor of an Argument.

Properties

$byReference  : IsApplicable
$default  : string|null
$description  : DescriptionDescriptor|null
$endLocation  : Location|null
$errors  : Collection<string|int, Error>
$fileDescriptor  : FileInterface|null
$fqsen  : Fqsen|null
$inheritedElement  : ElementInterface|string|Fqsen|null
$isVariadic  : IsApplicable
$line  : int
$name  : string
$namespace  : NamespaceInterface|string
$package  : PackageInterface|string
$startLocation  : Location|null
$summary  : string
$tags  : Collection<string|int, Collection<string|int, TagDescriptor>>
$type  : Type|null
$metadata  : array<string|int, Metadata>
$method  : MethodInterface

Methods

__call()  : Collection<string|int, TagDescriptor>|null
Dynamically constructs a set of getters to retrieve tag (collections) with.
__construct()  : mixed
Initializes this descriptor.
__toString()  : string
Represents this object by its unique identifier, the Fully Qualified Structural Element Name.
getAuthor()  : Collection<string|int, AuthorDescriptor>
getCopyright()  : Collection<string|int, TagDescriptor>
Returns the copyrights for this element.
getDefault()  : string|null
getDeprecations()  : array<string|int, Deprecation>
getDescription()  : DescriptionDescriptor
Returns the description for this element.
getEndLocation()  : Location|null
Returns the end location where the definition for this element can be found.
getErrors()  : Collection<string|int, Error>
Returns all errors that occur in this element.
getFile()  : FileInterface|null
Returns the file in which this element resides or null in case the element is not bound to a file.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getInheritedElement()  : ElementInterface|string|Fqsen|null
Returns the element from which this element inherits, or null if it doesn't inherit any information.
getLine()  : int
Returns the line number where the definition for this element can be found.
getMetadata()  : array<string|int, Metadata>
getMethod()  : MethodInterface
getName()  : string
Returns the name for this element.
getNamespace()  : NamespaceInterface|string
Returns the namespace for this element (defaults to global "\")
getPackage()  : PackageInterface|null
Returns the package name for this element.
getPath()  : string
Returns the path to the file containing this element relative to the project's root.
getStartLocation()  : Location|null
Returns the start location where the definition for this element can be found.
getSummary()  : string
Returns the summary which describes this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns the tags associated with this element.
getType()  : Type|null
getTypes()  : array<int, Type>
getVersion()  : Collection<string|int, VersionDescriptor>
Returns the versions for this element.
isByReference()  : bool
isDeprecated()  : bool
Checks whether this element is deprecated.
isVariadic()  : bool
Returns whether this argument represents a variadic argument.
setByReference()  : void
setDefault()  : void
setDescription()  : void
Sets a description or none to inherit from a parent.
setMetadata()  : void
setMethod()  : void
To which method does this argument belong to
setType()  : void
setVariadic()  : void
Sets whether this argument represents a variadic argument.
createDescription()  : Description
isDeprecatedByAttribute()  : bool
isDeprecatedByTag()  : bool

Properties

$default

protected string|null $default = null

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

$endLocation

protected Location|null $endLocation = null

$fileDescriptor

protected FileInterface|null $fileDescriptor = null

The file to which this element belongs; if applicable

$fqsen

protected Fqsen|null $fqsen = null

Fully Qualified Structural Element Name; the FQCN including method, property or constant name

$inheritedElement

protected ElementInterface|string|Fqsen|null $inheritedElement = null

the element from which to inherit information in this element

$line

protected int $line = 0

The line number on which this element occurs.

$startLocation

protected Location|null $startLocation = null

$summary

protected string $summary = ''

A summary describing the function of this element in short.

$type

protected Type|null $type = null

normalized type of this argument

$metadata

private array<string|int, Metadata> $metadata = []

Methods

__call()

Dynamically constructs a set of getters to retrieve tag (collections) with.

public __call(string $name, array<string|int, mixed> $arguments) : Collection<string|int, TagDescriptor>|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.

Parameters
$name : string
$arguments : array<string|int, mixed>
Return values
Collection<string|int, TagDescriptor>|null

__toString()

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

public __toString() : string
Return values
string

getEndLocation()

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

public getEndLocation() : Location|null
Return values
Location|null

getFile()

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

public getFile() : FileInterface|null

.

Return values
FileInterface|null

getFullyQualifiedStructuralElementName()

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

public getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|null

getLine()

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

public getLine() : int

use getStartLocation()->getLineNumber() instead

Return values
int

getMetadata()

public getMetadata() : array<string|int, Metadata>
Return values
array<string|int, Metadata>

getName()

Returns the name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getStartLocation()

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

public getStartLocation() : Location|null
Return values
Location|null

getSummary()

Returns the summary which describes this element.

public getSummary() : string

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

Return values
string

getType()

public getType() : Type|null
Return values
Type|null

getTypes()

public getTypes() : array<int, Type>
Return values
array<int, Type>

isDeprecated()

Checks whether this element is deprecated.

public isDeprecated() : bool
Return values
bool

isVariadic()

Returns whether this argument represents a variadic argument.

public isVariadic() : bool
Return values
bool

setDefault()

public setDefault(string|null $value) : void
Parameters
$value : string|null

setMetadata()

public setMetadata(array<string|int, Metadata> $metadata) : void
Parameters
$metadata : array<string|int, Metadata>

setType()

public setType(Type|null $type) : void
Parameters
$type : Type|null

createDescription()

private createDescription(string|null $param) : Description
Parameters
$param : string|null
Return values
Description

isDeprecatedByAttribute()

private isDeprecatedByAttribute() : bool
Tags
phpstan-assert-if-true

AttributedInterface $this

psalm-assert-if-true

AttributedInterface $this`[

Return values
bool

isDeprecatedByTag()

private isDeprecatedByTag() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results