ArgumentInterface

Extends \phpDocumentor\Descriptor\Interfaces\ElementInterface

Describes the public interface for a descriptor of an Argument.

package

Default

Methods

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

getDefault() : string|null

Response

string|null

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

Returns a longer description for this element.

getDescription() : string
inherited

Response

string

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

getFullyQualifiedStructuralElementName() : string
inherited

Response

string

Returns the line number where this element may be found.

getLine() : integer
inherited
see \phpDocumentor\Descriptor\Interfaces\ElementInterface::getPath()

to find out in which file this element is found.

Response

integer

Returns the local name for this element.

getName() : string
inherited

Response

string

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

getPath() : string
inherited

Response

string

Returns the summary describing this element.

getSummary() : string
inherited

Response

string

Returns all tags associated with this element.

getTags() : \phpDocumentor\Descriptor\Collection
inherited

Returns a normalized list of types.

getTypes() : \phpDocumentor\Descriptor\Collection

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

isByReference() : boolean

Response

boolean

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

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

setByReference(boolean $byReference) : void

Arguments

$byReference

boolean

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

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

setDefault(string $value) : void

Arguments

$value

string

A textual representation of the default value.

Sets a longer description for this element.

setDescription(string $description) : void
inherited

Arguments

$description

string

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

setFullyQualifiedStructuralElementName(string $name) : void
inherited

Arguments

$name

string

Sets the file and location for this element.

setLocation(\phpDocumentor\Descriptor\FileDescriptor $file, integer $line) : void
inherited

Arguments

$line

integer

Sets the local name for this element.

setName(string $name) : void
inherited

Arguments

$name

string

Sets a summary describing this element.

setSummary(string $summary) : void
inherited

Arguments

$summary

string

Sets a normalized list of types that the argument represents.

setTypes(\phpDocumentor\Descriptor\Collection $types) : 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.

link

Definition of a type.

todo

update link to point to the final destination for the PHPDoc Standard.

Arguments

$types

\phpDocumentor\Descriptor\Collection

An Collection of normalized types that should be in this Argument