AuthorTag
extends AbstractGenerator
in package
implements
TagInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- LINE_FEED = "\n"
- Line feed to use in place of EOL
- $authorEmail : string
- $authorName : string
- $indentation : int|string
- $isSourceDirty : bool
- $sourceContent : string
- __construct() : mixed
- fromReflection() : AuthorTag
- generate() : string
- getAuthorEmail() : string
- getAuthorName() : string
- getIndentation() : string
- getName() : string
- getSourceContent() : string
- isSourceDirty() : bool
- setAuthorEmail() : AuthorTag
- setAuthorName() : AuthorTag
- setIndentation() : AbstractGenerator
- setOptions() : AbstractGenerator
- setSourceContent() : AbstractGenerator
- setSourceDirty() : AbstractGenerator
Constants
LINE_FEED
Line feed to use in place of EOL
public
mixed
LINE_FEED
= "\n"
Properties
$authorEmail
protected
string
$authorEmail
$authorName
protected
string
$authorName
$indentation
protected
int|string
$indentation
= ' '
4 spaces by default
$isSourceDirty
protected
bool
$isSourceDirty
= true
$sourceContent
protected
string
$sourceContent
Methods
__construct()
public
__construct([string $authorName = null ][, string $authorEmail = null ]) : mixed
Parameters
- $authorName : string = null
- $authorEmail : string = null
Return values
mixed —fromReflection()
public
static fromReflection(TagInterface $reflectionTag) : AuthorTag
Parameters
- $reflectionTag : TagInterface
Tags
Return values
AuthorTag —generate()
public
generate() : string
Return values
string —getAuthorEmail()
public
getAuthorEmail() : string
Return values
string —getAuthorName()
public
getAuthorName() : string
Return values
string —getIndentation()
public
getIndentation() : string
Return values
string —getName()
public
getName() : string
Return values
string —getSourceContent()
public
getSourceContent() : string
Return values
string —isSourceDirty()
public
isSourceDirty() : bool
Return values
bool —setAuthorEmail()
public
setAuthorEmail(string $authorEmail) : AuthorTag
Parameters
- $authorEmail : string
Return values
AuthorTag —setAuthorName()
public
setAuthorName(string $authorName) : AuthorTag
Parameters
- $authorName : string
Return values
AuthorTag —setIndentation()
public
setIndentation(string $indentation) : AbstractGenerator
Parameters
- $indentation : string
Return values
AbstractGenerator —setOptions()
public
setOptions(array<string|int, mixed>|Traversable $options) : AbstractGenerator
Parameters
- $options : array<string|int, mixed>|Traversable
Tags
Return values
AbstractGenerator —setSourceContent()
public
setSourceContent(string $sourceContent) : AbstractGenerator
Parameters
- $sourceContent : string
Return values
AbstractGenerator —setSourceDirty()
public
setSourceDirty([bool $isSourceDirty = true ]) : AbstractGenerator
Parameters
- $isSourceDirty : bool = true