phpDocumentor

ArgumentInterface extends ElementInterface

Describes the public interface for a descriptor of an Argument.

Table of Contents

getDefault()  : string|null
Returns the default value for an argument as string or null if no default is set.
getDescription()  : DescriptionDescriptor|null
Returns a longer description for this element.
getFullyQualifiedStructuralElementName()  : Fqsen|null
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
getLine()  : int
Returns the line number where this element may be found.
getName()  : string
Returns the local name for this element.
getPath()  : string
Returns the file location for this element relative to the project root.
getSummary()  : string
Returns the summary describing this element.
getTags()  : Collection<string|int, Collection<string|int, TagDescriptor>>
Returns all tags associated with this element.
getType()  : Type|null
Returns a normalized Types.
isByReference()  : bool
Returns whether the parameter is passed by reference or by value.
setByReference()  : void
Sets whether this argument passes its parameter by reference or by value.
setDefault()  : void
Sets the default value for an argument expressed as a string.
setDescription()  : void
Sets a longer description for this element.
setFullyQualifiedStructuralElementName()  : void
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
setLocation()  : void
Sets the file and location for this element.
setName()  : void
Sets the local name for this element.
setSummary()  : void
Sets a summary describing this element.
setType()  : void
Sets a normalized list of types that the argument represents.

Methods

getDefault()

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

public getDefault() : string|null
Return values
string|null

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

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 this element may be found.

public getLine() : int
Tags
see
getPath()

to find out in which file this element is found.

Return values
int

getName()

Returns the local name for this element.

public getName() : string
Return values
string

getPath()

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

public getPath() : string
Return values
string

getSummary()

Returns the summary describing this element.

public getSummary() : string
Return values
string

getType()

Returns a normalized Types.

public getType() : Type|null
Tags
see
self::setTypes()

for details on what types represent.

Return values
Type|null

isByReference()

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

public isByReference() : bool
Return values
bool

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

setByReference()

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

public setByReference(bool $byReference) : void
Parameters
$byReference : bool

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

Return values
void

setDefault()

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

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

A textual representation of the default value.

Return values
void

setFullyQualifiedStructuralElementName()

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

public setFullyQualifiedStructuralElementName(Fqsen $name) : void
Parameters
$name : Fqsen
Return values
void

setName()

Sets the local name for this element.

public setName(string $name) : void
Parameters
$name : string
Return values
void

setSummary()

Sets a summary describing this element.

public setSummary(string $summary) : void
Parameters
$summary : string
Return values
void

setType()

Sets a normalized list of types that the argument represents.

public setType(Type|null $type) : 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.

Parameters
$type : Type|null

Type of this agument represented as a reflection type.

Tags
link

Definition of a type.

todo

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

Return values
void

Search results