AttributeDescriptor
in package
implements
Descriptor, Stringable, AttributeInterface
uses
HasName, HasDescription, HasFqsen
FinalYes
Table of Contents
Interfaces
- Descriptor
- Base class for descriptors containing the most used options.
- Stringable
- AttributeInterface
Properties
- $description : DescriptionDescriptor|null
- $fqsen : Fqsen|null
- $name : string
- $arguments : Collection<string|int, CallArgument>
- $attributeClass : ClassInterface|null
Methods
- __construct() : mixed
- __toString() : string
- addArgument() : void
- getArguments() : Collection<string|int, CallArgument>
- getAttribute() : ClassInterface|Fqsen|null
- getDescription() : DescriptionDescriptor
- Returns the description for this element.
- getFullyQualifiedStructuralElementName() : Fqsen|null
- Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
- getName() : string
- Returns the name for this element.
- hasArguments() : bool
- setAttribute() : void
- setDescription() : void
- Sets a description or none to inherit from a parent.
Properties
$description
protected
DescriptionDescriptor|null
$description
= null
$fqsen
protected
Fqsen|null
$fqsen
= null
Fully Qualified Structural Element Name; the FQCN including method, property or constant name
$name
protected
string
$name
= ''
$arguments
private
Collection<string|int, CallArgument>
$arguments
$attributeClass
private
ClassInterface|null
$attributeClass
= null
Methods
__construct()
public
__construct() : mixed
__toString()
public
__toString() : string
Return values
stringaddArgument()
public
addArgument(CallArgument $argument) : void
Parameters
- $argument : CallArgument
getArguments()
public
getArguments() : Collection<string|int, CallArgument>
Return values
Collection<string|int, CallArgument>getAttribute()
public
getAttribute() : ClassInterface|Fqsen|null
Return values
ClassInterface|Fqsen|nullgetDescription()
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
DescriptionDescriptorgetFullyQualifiedStructuralElementName()
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
public
getFullyQualifiedStructuralElementName() : Fqsen|null
Return values
Fqsen|nullgetName()
Returns the name for this element.
public
getName() : string
Return values
stringhasArguments()
public
hasArguments() : bool
Return values
boolsetAttribute()
public
setAttribute(ClassInterface|null $attributeClass) : void
Parameters
- $attributeClass : ClassInterface|null
setDescription()
Sets a description or none to inherit from a parent.
public
setDescription(DescriptionDescriptor|null $description) : void
Parameters
- $description : DescriptionDescriptor|null