FileGenerator
extends AbstractGenerator
in package
Table of Contents
Constants
- LINE_FEED = "\n"
- Line feed to use in place of EOL
Properties
- $body : string
- $classes : array<string|int, ClassGenerator>
- $declares : array<string|int, DeclareStatement>
- $docBlock : DocBlockGenerator|null
- $filename : string
- $indentation : string
- $isSourceDirty : bool
- $namespace : string
- $requiredFiles : array<string|int, string>
- $sourceContent : string|null
- TODO: Type should be changed to "string" in the next major version. Nullable for BC
- $uses : array<string|int, mixed>
Methods
- __construct() : mixed
- Passes $options to {@link setOptions()}.
- fromArray() : FileGenerator
- generate() : string
- getBody() : string
- getClass() : ClassGenerator
- getClasses() : array<string|int, ClassGenerator>
- getDocBlock() : DocBlockGenerator|null
- getFilename() : string
- getIndentation() : string
- getNamespace() : string
- getRequiredFiles() : array<string|int, string>
- getSourceContent() : string|null
- getUses() : array<string|int, mixed>
- Returns an array with the first element the use statement, second is the as part.
- isSourceDirty() : bool
- setBody() : FileGenerator
- setClass() : FileGenerator
- setClasses() : FileGenerator
- setDeclares() : static
- setDocBlock() : FileGenerator
- setFilename() : FileGenerator
- setIndentation() : AbstractGenerator
- setNamespace() : FileGenerator
- setOptions() : AbstractGenerator
- setRequiredFiles() : FileGenerator
- setSourceContent() : AbstractGenerator
- setSourceDirty() : AbstractGenerator
- setUse() : FileGenerator
- setUses() : FileGenerator
- write() : FileGenerator
Constants
LINE_FEED
Line feed to use in place of EOL
public
mixed
LINE_FEED
= "\n"
Properties
$body
protected
string
$body
= ''
$classes
protected
array<string|int, ClassGenerator>
$classes
= []
Tags
$declares
protected
array<string|int, DeclareStatement>
$declares
= []
Tags
$docBlock
protected
DocBlockGenerator|null
$docBlock
= null
$filename
protected
string
$filename
= ''
$indentation
protected
string
$indentation
= ' '
4 spaces by default
$isSourceDirty
protected
bool
$isSourceDirty
= true
$namespace
protected
string
$namespace
= ''
$requiredFiles
protected
array<string|int, string>
$requiredFiles
= []
$sourceContent
TODO: Type should be changed to "string" in the next major version. Nullable for BC
protected
string|null
$sourceContent
= null
$uses
protected
array<string|int, mixed>
$uses
= []
Tags
Methods
__construct()
Passes $options to {@link setOptions()}.
public
__construct([array<string|int, mixed>|Traversable|null $options = null ]) : mixed
Parameters
- $options : array<string|int, mixed>|Traversable|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $values) : FileGenerator
Parameters
- $values : array<string|int, mixed>
Return values
FileGeneratorgenerate()
public
generate() : string
Return values
stringgetBody()
public
getBody() : string
Return values
stringgetClass()
public
getClass([string|null $name = null ]) : ClassGenerator
Parameters
- $name : string|null = null
Tags
Return values
ClassGeneratorgetClasses()
public
getClasses() : array<string|int, ClassGenerator>
Return values
array<string|int, ClassGenerator>getDocBlock()
public
getDocBlock() : DocBlockGenerator|null
Return values
DocBlockGenerator|nullgetFilename()
public
getFilename() : string
Return values
stringgetIndentation()
public
getIndentation() : string
Return values
stringgetNamespace()
public
getNamespace() : string
Return values
stringgetRequiredFiles()
public
getRequiredFiles() : array<string|int, string>
Return values
array<string|int, string>getSourceContent()
public
getSourceContent() : string|null
Return values
string|nullgetUses()
Returns an array with the first element the use statement, second is the as part.
public
getUses([bool $withResolvedAs = false ]) : array<string|int, mixed>
If $withResolvedAs is set to true, there will be a third element that is the "resolved" as statement, as the second part is not required in use statements
Parameters
- $withResolvedAs : bool = false
Tags
Return values
array<string|int, mixed>isSourceDirty()
public
isSourceDirty() : bool
Return values
boolsetBody()
public
setBody(string $body) : FileGenerator
Parameters
- $body : string
Return values
FileGeneratorsetClass()
public
setClass(array<string|int, mixed>|string|ClassGenerator $class) : FileGenerator
Parameters
- $class : array<string|int, mixed>|string|ClassGenerator
Tags
Return values
FileGeneratorsetClasses()
public
setClasses(array<string|int, array<string|int, mixed>>|array<string|int, string>|array<string|int, ClassGenerator> $classes) : FileGenerator
Parameters
- $classes : array<string|int, array<string|int, mixed>>|array<string|int, string>|array<string|int, ClassGenerator>
Return values
FileGeneratorsetDeclares()
public
setDeclares(array<string|int, DeclareStatement> $declares) : static
Parameters
- $declares : array<string|int, DeclareStatement>
Return values
staticsetDocBlock()
public
setDocBlock(DocBlockGenerator|array<string|int, mixed>|string $docBlock) : FileGenerator
Parameters
- $docBlock : DocBlockGenerator|array<string|int, mixed>|string
Tags
Return values
FileGeneratorsetFilename()
public
setFilename(string $filename) : FileGenerator
Parameters
- $filename : string
Return values
FileGeneratorsetIndentation()
public
setIndentation(string $indentation) : AbstractGenerator
Parameters
- $indentation : string
Return values
AbstractGeneratorsetNamespace()
public
setNamespace(string $namespace) : FileGenerator
Parameters
- $namespace : string
Return values
FileGeneratorsetOptions()
public
setOptions(array<string|int, mixed>|Traversable $options) : AbstractGenerator
Parameters
- $options : array<string|int, mixed>|Traversable
Tags
Return values
AbstractGeneratorsetRequiredFiles()
public
setRequiredFiles(array<string|int, string> $requiredFiles) : FileGenerator
Parameters
- $requiredFiles : array<string|int, string>
Return values
FileGeneratorsetSourceContent()
public
setSourceContent(string|null $sourceContent) : AbstractGenerator
Parameters
- $sourceContent : string|null
Return values
AbstractGeneratorsetSourceDirty()
public
setSourceDirty([bool $isSourceDirty = true ]) : AbstractGenerator
Parameters
- $isSourceDirty : bool = true
Return values
AbstractGeneratorsetUse()
public
setUse(string $use[, null|string $as = null ]) : FileGenerator
Parameters
- $use : string
- $as : null|string = null
Return values
FileGeneratorsetUses()
public
setUses(array<string|int, mixed> $uses) : FileGenerator
Parameters
- $uses : array<string|int, mixed>
Return values
FileGeneratorwrite()
public
write() : FileGenerator