Uses
extends BaseTag
in package
implements
StaticMethod
Reflection class for a {@}uses tag in a Docblock.
Interfaces, Classes, Traits and Enums
Table of Contents
- $description : Description|null
- $name : string
- $refers : Fqsen
- __construct() : mixed
- Initializes this tag.
- __toString() : string
- Returns a string representation of this tag.
- create() : mixed
- getDescription() : Description|null
- getName() : string
- Gets the name of this tag.
- getReference() : Fqsen
- Returns the structural element this tag refers to.
- render() : string
- resolveFqsen() : Fqsen
Properties
$description
protected
Description|null
$description
Description of the tag.
$name
protected
string
$name
= 'uses'
$refers
protected
Fqsen
$refers
Methods
__construct()
Initializes this tag.
public
__construct(Fqsen $refers[, Description|null $description = null ]) : mixed
Parameters
- $refers : Fqsen
- $description : Description|null = null
Return values
mixed —__toString()
Returns a string representation of this tag.
public
__toString() : string
Return values
string —create()
public
static create(string $body[, FqsenResolver|null $resolver = null ][, DescriptionFactory|null $descriptionFactory = null ][, Context|null $context = null ]) : mixed
Parameters
- $body : string
- $resolver : FqsenResolver|null = null
- $descriptionFactory : DescriptionFactory|null = null
- $context : Context|null = null
Return values
mixed —getDescription()
public
getDescription() : Description|null
Return values
Description|null —getName()
Gets the name of this tag.
public
getName() : string
Return values
string —The name of this tag.
getReference()
Returns the structural element this tag refers to.
public
getReference() : Fqsen
Return values
Fqsen —render()
public
render([Formatter|null $formatter = null ]) : string
Parameters
- $formatter : Formatter|null = null
Return values
string —resolveFqsen()
private
static resolveFqsen(string $parts, FqsenResolver|null $fqsenResolver, Context|null $context) : Fqsen
Parameters
- $parts : string
- $fqsenResolver : FqsenResolver|null
- $context : Context|null