Copied!

Reflection class for an {@}author tag in a Docblock.

CloneableFinalInstantiable
Methods
public __construct(string $authorName, string $authorEmail)
 

Initializes this tag with the author name and e-mail.

public __toString() : string
 

Returns this tag in string form.

public static create(string $body) : ?self
 

Attempts to create a new Author object based on the tag body.

public getAuthorName() : string
 

Gets the author's name.

  • return string The author's name.
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getDescription() : ?phpDocumentor\Reflection\DocBlock\Description
public getEmail() : string
 

Returns the author's email.

  • return string The author's email.
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::getName() : string
 

Gets the name of this tag.

  • return string The name of this tag.
public phpDocumentor\Reflection\DocBlock\Tags\BaseTag::render(?phpDocumentor\Reflection\DocBlock\Tags\Formatter $formatter = NULL) : string
Properties
protected ?phpDocumentor\Reflection\DocBlock\Description phpDocumentor\Reflection\DocBlock\Tags\BaseTag::$description = NULL
 
  • var \Description|null Description of the tag.
protected string $name = 'author'
 
  • var string register that this is the author tag.
Properties
private string $authorEmail
 
  • var string The email of the author
private string $authorName
 
  • var string The name of the author
Methods
public static create(string $body) : ?self
 

Attempts to create a new Author object based on the tag body.

© 2024 Bruce Wells
Search Namespaces \ Classes
Configuration