PropertyHook
in package
implements
AttributeContainer, MetaDataContainer
uses
MetadataContainer, HasAttributes
FinalYes
Table of Contents
Interfaces
Properties
- $arguments : array<string|int, Argument>
- $attributes : array<string|int, Attribute>
- $docBlock : DocBlock|null
- $endLocation : Location
- $final : bool
- $location : Location
- $name : string
- $visibility : Visibility
Methods
- __construct() : mixed
- addArgument() : void
- Add new argument to this hook.
- addAttribute() : void
- getArguments() : array<string|int, Argument>
- Returns the arguments of this hook.
- getAttributes() : array<string|int, Attribute>
- getDocBlock() : DocBlock|null
- Returns the DocBlock of this method if available.
- getEndLocation() : Location
- getLocation() : Location
- getName() : string
- Returns the name of this hook.
- getVisibility() : Visibility|null
- Returns the Visibility of this hook.
- isFinal() : bool
- Returns true when this hook is final. Otherwise, returns false.
Properties
$arguments
private
array<string|int, Argument>
$arguments
= []
$attributes
private
array<string|int, Attribute>
$attributes
= []
$docBlock read-only
private
DocBlock|null
$docBlock
= null
$endLocation read-only
private
Location
$endLocation
$final read-only
private
bool
$final
= false
$location read-only
private
Location
$location
$name read-only
private
string
$name
$visibility read-only
private
Visibility
$visibility
Methods
__construct()
public
__construct(string $name, Visibility $visibility[, DocBlock|null $docBlock = null ][, bool $final = false ][, Location|null $location = null ][, Location|null $endLocation = null ]) : mixed
Parameters
- $name : string
- $visibility : Visibility
- $docBlock : DocBlock|null = null
- $final : bool = false
- $location : Location|null = null
- $endLocation : Location|null = null
addArgument()
Add new argument to this hook.
public
addArgument(Argument $argument) : void
Parameters
- $argument : Argument
addAttribute()
public
addAttribute(Attribute $attribute) : void
Parameters
- $attribute : Attribute
getArguments()
Returns the arguments of this hook.
public
getArguments() : array<string|int, Argument>
Return values
array<string|int, Argument>getAttributes()
public
getAttributes() : array<string|int, Attribute>
Return values
array<string|int, Attribute>getDocBlock()
Returns the DocBlock of this method if available.
public
getDocBlock() : DocBlock|null
Return values
DocBlock|nullgetEndLocation()
public
getEndLocation() : Location
Return values
LocationgetLocation()
public
getLocation() : Location
Return values
LocationgetName()
Returns the name of this hook.
public
getName() : string
Return values
stringgetVisibility()
Returns the Visibility of this hook.
public
getVisibility() : Visibility|null
Return values
Visibility|nullisFinal()
Returns true when this hook is final. Otherwise, returns false.
public
isFinal() : bool