TraitInterface
extends ElementInterface, TypeInterfacePublic interface definition for object representing traits.
Methods
setFullyQualifiedStructuralElementName() inherited
Sets the Fully Qualified Structural Element Name (FQSEN) for this element.
publicsetFullyQualifiedStructuralElementName(Fqsen $name) : void
getFullyQualifiedStructuralElementName() inherited
Returns the Fully Qualified Structural Element Name (FQSEN) for this element.
publicgetFullyQualifiedStructuralElementName() : Fqsen|null
setSummary() inherited
Sets a summary describing this element.
publicsetSummary(string $summary) : void
setDescription() inherited
Sets a longer description for this element.
publicsetDescription(string $description) : void
Parameters
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getDescription() inherited
Returns a longer description for this element.
publicgetDescription() : string
setLocation() inherited
Sets the file and location for this element.
publicsetLocation(FileDescriptor $file, int $line) : void
- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
getPath() inherited
Returns the file location for this element relative to the project root.
publicgetPath() : string
getTags() inherited
Returns all tags associated with this element.
publicgetTags() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\TagDescriptor> —- Inherited from
- \phpDocumentor\Descriptor\Interfaces\ElementInterface
__toString() inherited
public__toString() : string
setProperties() Line 30
Sets the properties associated with this trait.
publicsetProperties(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> $properties) : void
Parameters
getProperties() Line 37
Returns the properties associated with this trait.
publicgetProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —
getInheritedProperties() Line 44
Returns all properties inherited from parent traits.
publicgetInheritedProperties() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\PropertyDescriptor> —
setMethods() Line 51
Sets all methods belonging to this trait.
publicsetMethods(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> $methods) : void
Parameters
getMethods() Line 58
Returns all methods belonging to this trait.
publicgetMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>
Returns
\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor> —
getInheritedMethods() Line 65
Returns a list of all methods inherited from parent traits.
publicgetInheritedMethods() : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\MethodDescriptor>