Author
extends BaseTag
in package
implements
StaticMethod
Reflection class for an {@}author tag in a Docblock.
Interfaces, Classes and Traits
Table of Contents
- $description : Description|null
- $name : string
- $authorEmail : string
- $authorName : string
- __construct() : mixed
- Initializes this tag with the author name and e-mail.
- __toString() : string
- Returns this tag in string form.
- create() : mixed
- Attempts to create a new Author object based on the tag body.
- getAuthorName() : string
- Gets the author's name.
- getDescription() : Description|null
- getEmail() : string
- Returns the author's email.
- getName() : string
- Gets the name of this tag.
- render() : string
Properties
$description
protected
Description|null
$description
= null
Description of the tag.
$name
protected
string
$name
= 'author'
register that this is the author tag.
$authorEmail
private
string
$authorEmail
The email of the author
$authorName
private
string
$authorName
The name of the author
Methods
__construct()
Initializes this tag with the author name and e-mail.
public
__construct(string $authorName, string $authorEmail) : mixed
Parameters
- $authorName : string
- $authorEmail : string
Return values
mixed —__toString()
Returns this tag in string form.
public
__toString() : string
Return values
string —create()
Attempts to create a new Author object based on the tag body.
public
static create(string $body) : mixed
Parameters
- $body : string
Return values
mixed —getAuthorName()
Gets the author's name.
public
getAuthorName() : string
Return values
string —The author's name.
getDescription()
public
getDescription() : Description|null
Return values
Description|null —getEmail()
Returns the author's email.
public
getEmail() : string
Return values
string —The author's email.
getName()
Gets the name of this tag.
public
getName() : string
Return values
string —The name of this tag.
render()
public
render([Formatter|null $formatter = null ]) : string
Parameters
- $formatter : Formatter|null = null