AbstractMemberGenerator
extends AbstractGenerator
in package
AbstractYes
Table of Contents
Constants
- FLAG_ABSTRACT = 0x1
- FLAG_FINAL = 0x2
- FLAG_INTERFACE = 0x8
- FLAG_PRIVATE = 0x40
- FLAG_PROTECTED = 0x20
- FLAG_PUBLIC = 0x10
- FLAG_STATIC = 0x4
- LINE_FEED = "\n"
- Line feed to use in place of EOL
- VISIBILITY_PRIVATE = 'private'
- VISIBILITY_PROTECTED = 'protected'
- VISIBILITY_PUBLIC = 'public'
Properties
- $docBlock : DocBlockGenerator|null
- $flags : int
- $indentation : string
- $isSourceDirty : bool
- $name : string
- $sourceContent : string|null
- TODO: Type should be changed to "string" in the next major version. Nullable for BC
Methods
- __construct() : mixed
- addFlag() : AbstractMemberGenerator
- getDocBlock() : DocBlockGenerator|null
- getIndentation() : string
- getName() : string
- getSourceContent() : string|null
- getVisibility() : mixed
- isAbstract() : bool
- isFinal() : bool
- isInterface() : bool
- isSourceDirty() : bool
- isStatic() : bool
- removeDocBlock() : void
- removeFlag() : AbstractMemberGenerator
- setAbstract() : AbstractMemberGenerator
- setDocBlock() : AbstractMemberGenerator
- setFinal() : AbstractMemberGenerator
- setFlags() : AbstractMemberGenerator
- setIndentation() : AbstractGenerator
- setInterface() : AbstractMemberGenerator
- setName() : AbstractMemberGenerator
- setOptions() : AbstractGenerator
- setSourceContent() : AbstractGenerator
- setSourceDirty() : AbstractGenerator
- setStatic() : AbstractMemberGenerator
- setVisibility() : AbstractMemberGenerator
Constants
FLAG_ABSTRACT
public
mixed
FLAG_ABSTRACT
= 0x1
FLAG_FINAL
public
mixed
FLAG_FINAL
= 0x2
FLAG_INTERFACE
public
mixed
FLAG_INTERFACE
= 0x8
FLAG_PRIVATE
public
mixed
FLAG_PRIVATE
= 0x40
FLAG_PROTECTED
public
mixed
FLAG_PROTECTED
= 0x20
FLAG_PUBLIC
public
mixed
FLAG_PUBLIC
= 0x10
FLAG_STATIC
public
mixed
FLAG_STATIC
= 0x4
LINE_FEED
Line feed to use in place of EOL
public
mixed
LINE_FEED
= "\n"
VISIBILITY_PRIVATE
public
mixed
VISIBILITY_PRIVATE
= 'private'
VISIBILITY_PROTECTED
public
mixed
VISIBILITY_PROTECTED
= 'protected'
VISIBILITY_PUBLIC
public
mixed
VISIBILITY_PUBLIC
= 'public'
Properties
$docBlock
protected
DocBlockGenerator|null
$docBlock
= null
$flags
protected
int
$flags
= self::FLAG_PUBLIC
$indentation
protected
string
$indentation
= ' '
4 spaces by default
$isSourceDirty
protected
bool
$isSourceDirty
= true
$name
protected
string
$name
= ''
$sourceContent
TODO: Type should be changed to "string" in the next major version. Nullable for BC
protected
string|null
$sourceContent
= null
Methods
__construct()
public
__construct([array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $options : array<string|int, mixed> = []
addFlag()
public
addFlag(int $flag) : AbstractMemberGenerator
Parameters
- $flag : int
Return values
AbstractMemberGeneratorgetDocBlock()
public
getDocBlock() : DocBlockGenerator|null
Return values
DocBlockGenerator|nullgetIndentation()
public
getIndentation() : string
Return values
stringgetName()
public
getName() : string
Return values
stringgetSourceContent()
public
getSourceContent() : string|null
Return values
string|nullgetVisibility()
public
getVisibility() : mixed
Tags
isAbstract()
public
isAbstract() : bool
Return values
boolisFinal()
public
isFinal() : bool
Return values
boolisInterface()
public
isInterface() : bool
Return values
boolisSourceDirty()
public
isSourceDirty() : bool
Return values
boolisStatic()
public
isStatic() : bool
Return values
boolremoveDocBlock()
public
removeDocBlock() : void
removeFlag()
public
removeFlag(int $flag) : AbstractMemberGenerator
Parameters
- $flag : int
Return values
AbstractMemberGeneratorsetAbstract()
public
setAbstract(bool $isAbstract) : AbstractMemberGenerator
Parameters
- $isAbstract : bool
Return values
AbstractMemberGeneratorsetDocBlock()
public
setDocBlock(DocBlockGenerator|string $docBlock) : AbstractMemberGenerator
Parameters
- $docBlock : DocBlockGenerator|string
Tags
Return values
AbstractMemberGeneratorsetFinal()
public
setFinal(bool $isFinal) : AbstractMemberGenerator
Parameters
- $isFinal : bool
Return values
AbstractMemberGeneratorsetFlags()
public
setFlags(int|array<string|int, int> $flags) : AbstractMemberGenerator
Parameters
- $flags : int|array<string|int, int>
Return values
AbstractMemberGeneratorsetIndentation()
public
setIndentation(string $indentation) : AbstractGenerator
Parameters
- $indentation : string
Return values
AbstractGeneratorsetInterface()
public
setInterface(bool $isInterface) : AbstractMemberGenerator
Parameters
- $isInterface : bool
Return values
AbstractMemberGeneratorsetName()
public
setName(string $name) : AbstractMemberGenerator
Parameters
- $name : string
Return values
AbstractMemberGeneratorsetOptions()
public
setOptions(array<string|int, mixed>|Traversable $options) : AbstractGenerator
Parameters
- $options : array<string|int, mixed>|Traversable
Tags
Return values
AbstractGeneratorsetSourceContent()
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
AbstractGeneratorsetStatic()
public
setStatic(bool $isStatic) : AbstractMemberGenerator
Parameters
- $isStatic : bool
Return values
AbstractMemberGeneratorsetVisibility()
public
setVisibility(string $visibility) : AbstractMemberGenerator
Parameters
- $visibility : string