PropertyHookInterface extends DocblockInterface, AttributedInterface, Descriptor
Table of Contents
Methods
- addAttribute() : void
- getArguments() : Collection<string|int, ArgumentInterface>
- getAttributes() : Collection<string|int, AttributeInterface>
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getName() : "get"|"set"
- Returns the name of a property hook.
- getSummary() : string
- Returns the summary describing this element.
- getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
- Returns all tags associated with this element.
- setDescription() : void
- Sets a longer description for this element.
- setName() : void
- Sets the local name for this element.
- setSummary() : void
- Sets a summary describing this element.
Methods
addAttribute()
public
addAttribute(AttributeInterface $attribute) : void
Parameters
- $attribute : AttributeInterface
getArguments()
public
getArguments() : Collection<string|int, ArgumentInterface>
Return values
Collection<string|int, ArgumentInterface>getAttributes()
public
getAttributes() : Collection<string|int, AttributeInterface>
Return values
Collection<string|int, AttributeInterface>getDescription()
Returns the description for this element.
public
getDescription() : DescriptionDescriptor
This method will automatically attempt to inherit the parent's description if this one has none.
Return values
DescriptionDescriptorgetName()
Returns the name of a property hook.
public
getName() : "get"|"set"
Return values
"get"|"set"getSummary()
Returns the summary describing this element.
public
getSummary() : string
Return values
stringgetTags()
Returns all tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Return values
Collection<string|int, Collection<string|int, TagDescriptor>>setDescription()
Sets a longer description for this element.
public
setDescription(DescriptionDescriptor $description) : void
Parameters
- $description : DescriptionDescriptor
setName()
Sets the local name for this element.
public
setName(string $name) : void
Parameters
- $name : string
setSummary()
Sets a summary describing this element.
public
setSummary(string $summary) : void
Parameters
- $summary : string