AbstractClassGenerator
extends AbstractGenerator
in package
Uses
NameTrait, NamespaceTrait, DocblockTrait
AbstractYes
Abstract class generator class
Tags
Table of Contents
Properties
- $constants : array<string|int, mixed>
- Array of constant generator objects
- $docblock : DocblockGenerator|null
- Docblock generator object
- $indent : int
- Code indent spaces
- $methods : array<string|int, mixed>
- Array of method generator objects
- $name : string|null
- Name
- $namespace : NamespaceGenerator|null
- Namespace generator object
- $output : string|null
- Output string
Methods
- addConstant() : AbstractClassGenerator
- Add a constant
- addConstants() : AbstractClassGenerator
- Add constants
- addMethod() : AbstractClassGenerator
- Add a method
- addMethods() : AbstractClassGenerator
- Add methods
- getConstant() : ConstantGenerator|null
- Get a constant
- getConstants() : array<string|int, mixed>
- Get all constants
- getDesc() : string|null
- Get the docblock description
- getDocblock() : DocblockGenerator|null
- Access the docblock generator object
- getIndent() : int
- Get the indent
- getMethod() : MethodGenerator|null
- Get a method
- getMethods() : array<string|int, mixed>
- Get all methods
- getName() : string|null
- Get the name
- getNamespace() : NamespaceGenerator|null
- Access the namespace generator object
- getOutput() : string
- Get the output
- hasConstant() : bool
- Has a constant
- hasConstants() : bool
- Has constants
- hasDesc() : bool
- Has a docblock description
- hasDocblock() : bool
- Has docblock generator object
- hasIndent() : bool
- Has indent
- hasMethod() : bool
- Has a method
- hasMethods() : bool
- Has methods
- hasName() : bool
- Get the name
- hasNamespace() : bool
- Has a namespace generator object
- hasOutput() : bool
- Has output
- isRendered() : bool
- Is rendered (alias to hasOutput())
- printIndent() : string
- Print the indent
- removeConstant() : AbstractClassGenerator
- Remove a constant
- removeMethod() : AbstractClassGenerator
- Remove a method
- render() : string
- Render method
- setDesc() : static
- Set the docblock description
- setDocblock() : static
- Set the docblock generator object
- setIndent() : AbstractGenerator
- Set the indent
- setName() : static
- Set the name
- setNamespace() : static
- Set the namespace generator object
Properties
$constants
Array of constant generator objects
protected
array<string|int, mixed>
$constants
= []
$docblock
Docblock generator object
protected
DocblockGenerator|null
$docblock
= null
$indent
Code indent spaces
protected
int
$indent
= 4
$methods
Array of method generator objects
protected
array<string|int, mixed>
$methods
= []
$name
Name
protected
string|null
$name
= null
$namespace
Namespace generator object
protected
NamespaceGenerator|null
$namespace
= null
$output
Output string
protected
string|null
$output
= null
Methods
addConstant()
Add a constant
public
addConstant(ConstantGenerator $constant) : AbstractClassGenerator
Parameters
- $constant : ConstantGenerator
Return values
AbstractClassGeneratoraddConstants()
Add constants
public
addConstants(array<string|int, mixed> $constants) : AbstractClassGenerator
Parameters
- $constants : array<string|int, mixed>
Return values
AbstractClassGeneratoraddMethod()
Add a method
public
addMethod(MethodGenerator $method) : AbstractClassGenerator
Parameters
- $method : MethodGenerator
Return values
AbstractClassGeneratoraddMethods()
Add methods
public
addMethods(array<string|int, mixed> $methods) : AbstractClassGenerator
Parameters
- $methods : array<string|int, mixed>
Return values
AbstractClassGeneratorgetConstant()
Get a constant
public
getConstant(mixed $constant) : ConstantGenerator|null
Parameters
- $constant : mixed
Return values
ConstantGenerator|nullgetConstants()
Get all constants
public
getConstants() : array<string|int, mixed>
Return values
array<string|int, mixed>getDesc()
Get the docblock description
public
getDesc() : string|null
Return values
string|nullgetDocblock()
Access the docblock generator object
public
getDocblock() : DocblockGenerator|null
Return values
DocblockGenerator|nullgetIndent()
Get the indent
public
getIndent() : int
Return values
intgetMethod()
Get a method
public
getMethod(mixed $method) : MethodGenerator|null
Parameters
- $method : mixed
Return values
MethodGenerator|nullgetMethods()
Get all methods
public
getMethods() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
Get the name
public
getName() : string|null
Return values
string|nullgetNamespace()
Access the namespace generator object
public
getNamespace() : NamespaceGenerator|null
Return values
NamespaceGenerator|nullgetOutput()
Get the output
public
getOutput() : string
Return values
stringhasConstant()
Has a constant
public
hasConstant(mixed $constant) : bool
Parameters
- $constant : mixed
Return values
boolhasConstants()
Has constants
public
hasConstants() : bool
Return values
boolhasDesc()
Has a docblock description
public
hasDesc() : bool
Return values
boolhasDocblock()
Has docblock generator object
public
hasDocblock() : bool
Return values
boolhasIndent()
Has indent
public
hasIndent() : bool
Return values
boolhasMethod()
Has a method
public
hasMethod(mixed $method) : bool
Parameters
- $method : mixed
Return values
boolhasMethods()
Has methods
public
hasMethods() : bool
Return values
boolhasName()
Get the name
public
hasName() : bool
Return values
boolhasNamespace()
Has a namespace generator object
public
hasNamespace() : bool
Return values
boolhasOutput()
Has output
public
hasOutput() : bool
Return values
boolisRendered()
Is rendered (alias to hasOutput())
public
isRendered() : bool
Return values
boolprintIndent()
Print the indent
public
printIndent() : string
Return values
stringremoveConstant()
Remove a constant
public
removeConstant(mixed $constant) : AbstractClassGenerator
Parameters
- $constant : mixed
Return values
AbstractClassGeneratorremoveMethod()
Remove a method
public
removeMethod(mixed $method) : AbstractClassGenerator
Parameters
- $method : mixed
Return values
AbstractClassGeneratorrender()
Render method
public
abstract render() : string
Return values
stringsetDesc()
Set the docblock description
public
setDesc([string|null $desc = null ]) : static
Parameters
- $desc : string|null = null
Return values
staticsetDocblock()
Set the docblock generator object
public
setDocblock(DocblockGenerator $docblock) : static
Parameters
- $docblock : DocblockGenerator
Return values
staticsetIndent()
Set the indent
public
setIndent(int $indent) : AbstractGenerator
Parameters
- $indent : int
Return values
AbstractGeneratorsetName()
Set the name
public
setName(string $name) : static
Parameters
- $name : string
Return values
staticsetNamespace()
Set the namespace generator object
public
setNamespace(NamespaceGenerator $namespace) : static
Parameters
- $namespace : NamespaceGenerator