Methods

__construct()

__construct(\Zend\Code\Scanner\ClassScanner $classScanner, \Zend\Code\Scanner\DirectoryScanner $directoryScanner) : \Zend\Code\Scanner\ClassScanner

__toString()

__toString() 
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::__toString()

export()

export() 
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::export()

Get annotations

getAnnotations(\Zend\Code\Annotation\AnnotationManager $annotationManager) : \Zend\Code\Annotation\AnnotationCollection
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getAnnotations()

Parameters

Returns

Return a single constant by given name or index of info

getConstant(string | int $constantNameOrInfoIndex) : bool | \Zend\Code\Scanner\ConstantScanner

Parameters

$constantNameOrInfoIndex

stringint

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

Return a list of constant names

getConstantNames() : array

Returns

array

Return a list of constants

getConstants(bool $namesOnly) : array | \Zend\Code\Scanner\ConstantScanner[]

Parameters

$namesOnly

bool

Set false to return instances of ConstantScanner

Returns

Return documentation block

getDocBlock() : false | \Zend\Code\Scanner\DocBlockScanner
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getDocBlock()

Returns

Return documentation comment

getDocComment() : null | string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getDocComment()

Returns

nullstring

Return a list of interface names

getInterfaces(bool $returnClassScanners) : array

Parameters

$returnClassScanners

bool

Returns

array

Return number of last line

getLineEnd() : int | null
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getLineEnd()

Returns

intnull

Return number of first line

getLineStart() : int | null
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getLineStart()

Returns

intnull

Return a single method by given name or index of info

getMethod(int | string $methodNameOrInfoIndex) : \Zend\Code\Scanner\MethodScanner

Parameters

$methodNameOrInfoIndex

intstring

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

Return a list of method names

getMethodNames() : array

Returns

array

Return a list of methods

getMethods() : \Zend\Code\Scanner\MethodScanner[]

Return a name of class

getName() : null | string

Returns

nullstring

Return a name of parent class

getParentClass() : null | string

Returns

nullstring

getParentClasses()

getParentClasses() : array

Returns

array

Return a list of properties

getProperties(bool $returnScannerProperty) : array

Parameters

$returnScannerProperty

bool

Returns

array

Return a single property by given name or index of info

getProperty(string | int $propertyNameOrInfoIndex) : bool | \Zend\Code\Scanner\PropertyScanner

Parameters

$propertyNameOrInfoIndex

stringint

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

Return a list of property names

getPropertyNames() : array

Returns

array

Return short name of class

getShortName() : null | string

Returns

nullstring

Retrieve a list of aliased traits used by the class.

getTraitAliases() : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getTraitAliases()

Returns

array

Retrieve a list of trait names used by this class.

getTraitNames() : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getTraitNames()

Returns

array

Retrieve any traits used by the class.

getTraits() : \Zend\Code\Scanner\ClassScanner[]
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getTraits()

Returns

Verify if class or parent class has constant

hasConstant(string $name) : bool

Parameters

$name

string

Returns

bool

Verify if class or parent class has method by given name

hasMethod(string $name) : bool

Parameters

$name

string

Returns

bool

Verify if class has parent

hasParentClass() : bool

Returns

bool

Verify if class or parent class has property

hasProperty(string $name) : bool

Parameters

$name

string

Returns

bool

Verify if class is an abstract class

isAbstract() : bool

Returns

bool

Verify if class is final

isFinal() : bool

Returns

bool

Verify if class is instantiable

isInstantiable() : bool

Returns

bool

Verify if class is an interface

isInterface() : bool

Returns

bool

Verify if class is a trait

isTrait() : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::isTrait()

Returns

bool

Return an array of key = trait to keep, value = trait::method to ignore

getBlockedTraitMethods() : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getBlockedTraitMethods()

Returns

array

Retrieve visibility for a given alias.

getVisibilityForAlias(mixed $aliasName) : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::getVisibilityForAlias()

Parameters

$aliasName

mixed

Returns

string

Scan tokens

scan() : void
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::scan()

Exceptions

\Zend\Code\Exception\RuntimeException

 Properties

 

$classScanner

$classScanner : \Zend\Code\Scanner\ClassScanner

 

$directoryScanner

$directoryScanner : \Zend\Code\Scanner\DirectoryScanner

 

$docComment

$docComment : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$docComment
 

$infos

$infos : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$infos
 

$interfaceClassScanners

$interfaceClassScanners : array

 

$interfaces

$interfaces : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$interfaces
 

$isAbstract

$isAbstract : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$isAbstract
 

$isFinal

$isFinal : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$isFinal
 

$isInterface

$isInterface : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$isInterface
 

$isScanned

$isScanned : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$isScanned
 

$isTrait

$isTrait : bool
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$isTrait
 

$lineEnd

$lineEnd : int
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$lineEnd
 

$lineStart

$lineStart : int
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$lineStart
 

$methods

$methods : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$methods
 

$name

$name : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$name
 

$nameInformation

$nameInformation : \Zend\Code\NameInformation
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$nameInformation
 

$parentClass

$parentClass : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$parentClass
 

$parentClassScanners

$parentClassScanners : array

 

$shortInterfaces

$shortInterfaces : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$shortInterfaces
 

$shortName

$shortName : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$shortName
 

$shortParentClass

$shortParentClass : string
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$shortParentClass
 

$tokens

$tokens : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$tokens
 

$traits

$traits : array
Inherited

inherited_from \Zend\Code\Scanner\ClassScanner::$$traits