Zend Framework
Back to top  

 Methods

__construct() 

__construct(string $name, string $namespaceName, array | string $flags, string $extends, array $interfaces, array $properties, array $methods, \Zend\Code\Generator\DocBlockGenerator $docBlock) 

Parameters

$name

string

$namespaceName

string

$flags

arraystring

$extends

string

$interfaces

array

$properties

array

$methods

array

$docBlock

\Zend\Code\Generator\DocBlockGenerator

Add Constant

addConstant(string $name, string $value) : \Zend\Code\Generator\ClassGenerator

Parameters

$name

string

$value

string

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

Add constant from PropertyGenerator

addConstantFromGenerator(\Zend\Code\Generator\PropertyGenerator $constant) : \Zend\Code\Generator\ClassGenerator

Parameters

$constant

\Zend\Code\Generator\PropertyGenerator

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

addConstants() 

addConstants(array $constants) : \Zend\Code\Generator\ClassGenerator

Parameters

$constants

\Zend\Code\Generator\PropertyGenerator[]array[]

Returns

\Zend\Code\Generator\ClassGenerator

addFlag() 

addFlag(string $flag) : \Zend\Code\Generator\ClassGenerator

Parameters

$flag

string

Returns

\Zend\Code\Generator\ClassGenerator

Add Method from scalars

addMethod(string $name, array $parameters, int $flags, string $body, string $docBlock) : \Zend\Code\Generator\ClassGenerator

Parameters

$name

string

$parameters

array

$flags

int

$body

string

$docBlock

string

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

Add Method from MethodGenerator

addMethodFromGenerator(\Zend\Code\Generator\MethodGenerator $method) : \Zend\Code\Generator\ClassGenerator

Parameters

$method

\Zend\Code\Generator\MethodGenerator

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

addMethods() 

addMethods(array $methods) : \Zend\Code\Generator\ClassGenerator

Parameters

$methods

array

Returns

\Zend\Code\Generator\ClassGenerator

addProperties() 

addProperties(array $properties) : \Zend\Code\Generator\ClassGenerator

Parameters

$properties

array

Returns

\Zend\Code\Generator\ClassGenerator

Add Property from scalars

addProperty(string $name, string | array $defaultValue, int $flags) : \Zend\Code\Generator\ClassGenerator

Parameters

$name

string

$defaultValue

stringarray

$flags

int

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

Add property from PropertyGenerator

addPropertyFromGenerator(\Zend\Code\Generator\PropertyGenerator $property) : \Zend\Code\Generator\ClassGenerator

Parameters

$property

\Zend\Code\Generator\PropertyGenerator

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

addTrait() 

addTrait($trait) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$trait

addTraitAlias() 

addTraitAlias($method, $alias, $visibility) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$method

$alias

$visibility

addTraitOverride() 

addTraitOverride($method, $traitsToReplace) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$method

$traitsToReplace

addTraits() 

addTraits(array $traits) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$traits

Add a class to "use" classes

addUse(string $use, string | null $useAlias) : \Zend\Code\Generator\ClassGenerator

Parameters

$use

string

$useAlias

stringnull

Returns

\Zend\Code\Generator\ClassGenerator

Generate from array

fromArray(array $array) : \Zend\Code\Generator\ClassGenerator

configkey name string [required] Class Name
configkey filegenerator FileGenerator File generator that holds this class
configkey namespacename string The namespace for this class
configkey docblock string The docblock information
configkey flags int Flags, one of ClassGenerator::FLAG_ABSTRACT ClassGenerator::FLAG_FINAL
configkey extendedclass string Class which this class is extending
configkey implementedinterfaces
configkey properties
configkey methods

Parameters

$array

array

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\ClassGenerator

Build a Code Generation Php Object from a Class Reflection

fromReflection(\Zend\Code\Reflection\ClassReflection $classReflection) : \Zend\Code\Generator\ClassGenerator

Parameters

$classReflection

\Zend\Code\Reflection\ClassReflection

Returns

\Zend\Code\Generator\ClassGenerator

generate() 

generate() 

inherit Zend\Code\Generator\GeneratorInterface

getConstant() 

getConstant(string $constantName) : \Zend\Code\Generator\PropertyGenerator | false

Parameters

$constantName

string

Returns

\Zend\Code\Generator\PropertyGeneratorfalse

getConstants() 

getConstants() : \Zend\Code\Generator\PropertyGenerator[]

Returns

\Zend\Code\Generator\PropertyGenerator[]indexed by constant name

getContainingFileGenerator() 

getContainingFileGenerator() : \Zend\Code\Generator\FileGenerator

Returns

\Zend\Code\Generator\FileGenerator

getDocBlock() 

getDocBlock() : \Zend\Code\Generator\DocBlockGenerator

Returns

\Zend\Code\Generator\DocBlockGenerator

getExtendedClass() 

getExtendedClass() : string

Returns

string

getImplementedInterfaces() 

getImplementedInterfaces() : array

Returns

array

getIndentation() 

getIndentation() : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::getIndentation()

Returns

string

getMethod() 

getMethod(string $methodName) : \Zend\Code\Generator\MethodGenerator | false

Parameters

$methodName

string

Returns

\Zend\Code\Generator\MethodGeneratorfalse

getMethods() 

getMethods() : \Zend\Code\Generator\MethodGenerator[]

Returns

\Zend\Code\Generator\MethodGenerator[]

getName() 

getName() : string

Returns

string

getNamespaceName() 

getNamespaceName() : string

Returns

string

getProperties() 

getProperties() : \Zend\Code\Generator\PropertyGenerator[]

Returns

\Zend\Code\Generator\PropertyGenerator[]

getProperty() 

getProperty(string $propertyName) : \Zend\Code\Generator\PropertyGenerator | false

Parameters

$propertyName

string

Returns

\Zend\Code\Generator\PropertyGeneratorfalse

getSourceContent() 

getSourceContent() : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::getSourceContent()

Returns

string

getTraitAliases() 

getTraitAliases() 

inherit Zend\Code\Generator\TraitUsageInterface

getTraitOverrides() 

getTraitOverrides() 

inherit Zend\Code\Generator\TraitUsageInterface

getTraits() 

getTraits() 

inherit Zend\Code\Generator\TraitUsageInterface

Returns the "use" classes

getUses() : array

Returns

array

hasConstant() 

hasConstant(string $constantName) : bool

Parameters

$constantName

string

Returns

bool

hasMethod() 

hasMethod(string $methodName) : bool

Parameters

$methodName

string

Returns

bool

hasProperty() 

hasProperty(string $propertyName) : bool

Parameters

$propertyName

string

Returns

bool

hasTrait() 

hasTrait($traitName) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$traitName

isAbstract() 

isAbstract() : bool

Returns

bool

isFinal() 

isFinal() : bool

Returns

bool

isSourceDirty() 

isSourceDirty() : bool

Returns

bool

removeFlag() 

removeFlag(string $flag) : \Zend\Code\Generator\ClassGenerator

Parameters

$flag

string

Returns

\Zend\Code\Generator\ClassGenerator

removeMethod() 

removeMethod(string $methodName) : \Zend\Code\Generator\ClassGenerator

Parameters

$methodName

string

Returns

\Zend\Code\Generator\ClassGenerator

removeTrait() 

removeTrait($traitName) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$traitName

removeTraitOverride() 

removeTraitOverride($method, $overridesToRemove) 

inherit Zend\Code\Generator\TraitUsageInterface

Parameters

$method

$overridesToRemove

setAbstract() 

setAbstract(bool $isAbstract) : \Zend\Code\Generator\ClassGenerator

Parameters

$isAbstract

bool

Returns

\Zend\Code\Generator\ClassGenerator

setContainingFileGenerator() 

setContainingFileGenerator(\Zend\Code\Generator\FileGenerator $fileGenerator) : \Zend\Code\Generator\ClassGenerator

Parameters

$fileGenerator

\Zend\Code\Generator\FileGenerator

Returns

\Zend\Code\Generator\ClassGenerator

setDocBlock() 

setDocBlock(\Zend\Code\Generator\DocBlockGenerator $docBlock) : \Zend\Code\Generator\ClassGenerator

Parameters

$docBlock

\Zend\Code\Generator\DocBlockGenerator

Returns

\Zend\Code\Generator\ClassGenerator

setExtendedClass() 

setExtendedClass(string $extendedClass) : \Zend\Code\Generator\ClassGenerator

Parameters

$extendedClass

string

Returns

\Zend\Code\Generator\ClassGenerator

setFinal() 

setFinal(bool $isFinal) : \Zend\Code\Generator\ClassGenerator

Parameters

$isFinal

bool

Returns

\Zend\Code\Generator\ClassGenerator

setFlags() 

setFlags(array | string $flags) : \Zend\Code\Generator\ClassGenerator

Parameters

$flags

arraystring

Returns

\Zend\Code\Generator\ClassGenerator

setImplementedInterfaces() 

setImplementedInterfaces(array $implementedInterfaces) : \Zend\Code\Generator\ClassGenerator

Parameters

$implementedInterfaces

array

Returns

\Zend\Code\Generator\ClassGenerator

setIndentation() 

setIndentation(string $indentation) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setIndentation()

Parameters

$indentation

string

Returns

\Zend\Code\Generator\AbstractGenerator

setName() 

setName(string $name) : \Zend\Code\Generator\ClassGenerator

Parameters

$name

string

Returns

\Zend\Code\Generator\ClassGenerator

setNamespaceName() 

setNamespaceName(string $namespaceName) : \Zend\Code\Generator\ClassGenerator

Parameters

$namespaceName

string

Returns

\Zend\Code\Generator\ClassGenerator

setOptions() 

setOptions(array | \Traversable $options) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setOptions()

Parameters

$options

array\Traversable

Exceptions

\Zend\Code\Generator\Exception\InvalidArgumentException

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceContent() 

setSourceContent(string $sourceContent) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setSourceContent()

Parameters

$sourceContent

string

Returns

\Zend\Code\Generator\AbstractGenerator

setSourceDirty() 

setSourceDirty(bool $isSourceDirty) : \Zend\Code\Generator\AbstractGenerator
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::setSourceDirty()

Parameters

$isSourceDirty

bool

Returns

\Zend\Code\Generator\AbstractGenerator

 Properties

 

<p>Array of constants</p>

$constants : \Zend\Code\Generator\PropertyGenerator[]

 

$containingFileGenerator

$containingFileGenerator : \Zend\Code\Generator\FileGenerator

 

$docBlock

$docBlock : \Zend\Code\Generator\DocBlockGenerator

 

$extendedClass

$extendedClass : string

 

$flags

$flags : bool

 

<p>Array of string names</p>

$implementedInterfaces : array

 

<p>4 spaces by default</p>

$indentation : int | string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$indentation
 

$isSourceDirty

$isSourceDirty : bool
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$isSourceDirty
 

<p>Array of methods</p>

$methods : \Zend\Code\Generator\MethodGenerator[]

 

$name

$name : string

 

$namespaceName

$namespaceName : string

 

<p>Array of properties</p>

$properties : \Zend\Code\Generator\PropertyGenerator[]

 

$sourceContent

$sourceContent : string
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::$$sourceContent
 

<p>Object to encapsulate trait usage logic</p>

$traitUsageGenerator : \Zend\Code\Generator\TraitUsageGenerator

 Constants

 

FLAG_ABSTRACT

FLAG_ABSTRACT 

 

FLAG_FINAL

FLAG_FINAL 

 

Line feed to use in place of EOL

LINE_FEED 
Inherited

inherited_from \Zend\Code\Generator\AbstractGenerator::LINE_FEED
 

OBJECT_TYPE

OBJECT_TYPE