PropertyHookDescriptor
in package
implements
Descriptor, PropertyHookInterface
uses
HasName, HasVisibility, HasSummary, HasDescription, HasTags, HasAttributes, HasMetadata
FinalYes
Table of Contents
Interfaces
- Descriptor
- Base class for descriptors containing the most used options.
- PropertyHookInterface
Properties
- $attributes : Collection<string|int, AttributeInterface>
- $description : DescriptionDescriptor|null
- $name : string
- $summary : string
- $tags : Collection<string|int, Collection<string|int, TagDescriptor>>
- $visibility : Visibility|null
- $arguments : Collection<string|int, ArgumentInterface>
- $metadata : array<string|int, Metadata>
Methods
- __construct() : mixed
- addArgument() : void
- getArguments() : Collection<string|int, ArgumentInterface>
- getAttributes() : Collection<string|int, AttributeInterface>
- getAuthor() : Collection<string|int, AuthorDescriptor>
- getCopyright() : Collection<string|int, TagDescriptor>
- Returns the copyrights for this element.
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getMetadata() : array<string|int, Metadata>
- getName() : string
- Returns the name for this element.
- getSummary() : string
- Returns the summary which describes this element.
- getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
- Returns the tags associated with this element.
- getVersion() : Collection<string|int, VersionDescriptor>
- Returns the versions for this element.
- getVisibility() : Visibility
- setDescription() : void
- Sets a description or none to inherit from a parent.
- setMetadata() : void
- setVisibility() : void
Properties
$attributes
protected
Collection<string|int, AttributeInterface>
$attributes
Attributes set on this class.
$description
protected
DescriptionDescriptor|null
$description
= null
$name
protected
string
$name
= ''
$summary
protected
string
$summary
= ''
A summary describing the function of this element in short.
$tags
protected
Collection<string|int, Collection<string|int, TagDescriptor>>
$tags
The tags associated with this element.
$visibility
protected
Visibility|null
$visibility
= null
$arguments
private
Collection<string|int, ArgumentInterface>
$arguments
$metadata
private
array<string|int, Metadata>
$metadata
= []
Methods
__construct()
public
__construct() : mixed
addArgument()
public
addArgument(string $name, ArgumentInterface $argument) : void
Parameters
- $name : string
- $argument : ArgumentInterface
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>getAuthor()
public
getAuthor() : Collection<string|int, AuthorDescriptor>
Return values
Collection<string|int, AuthorDescriptor>getCopyright()
Returns the copyrights for this element.
public
getCopyright() : Collection<string|int, TagDescriptor>
Return values
Collection<string|int, TagDescriptor>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
DescriptionDescriptorgetMetadata()
public
getMetadata() : array<string|int, Metadata>
Return values
array<string|int, Metadata>getName()
Returns the name for this element.
public
getName() : string
Return values
stringgetSummary()
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
stringgetTags()
Returns the tags associated with this element.
public
getTags() : Collection<string|int, Collection<string|int, TagDescriptor>>
Return values
Collection<string|int, Collection<string|int, TagDescriptor>>getVersion()
Returns the versions for this element.
public
getVersion() : Collection<string|int, VersionDescriptor>
Return values
Collection<string|int, VersionDescriptor>getVisibility()
public
getVisibility() : Visibility
Return values
VisibilitysetDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null
setMetadata()
public
setMetadata(array<string|int, Metadata> $metadata) : void
Parameters
- $metadata : array<string|int, Metadata>
setVisibility()
public
setVisibility(Visibility $visibility) : void
Parameters
- $visibility : Visibility