package Default
inherited_from \Zend\Code\Scanner\ClassScanner

 Methods

__construct()

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

Parameters

$classScanner

\Zend\Code\Scanner\ClassScanner

$directoryScanner

\Zend\Code\Scanner\DirectoryScanner

__construct()

__construct(array $classTokens, \Zend\Code\NameInformation|null $nameInformation = null) : \Zend\Code\Scanner\ClassScanner
Inherited

Parameters

$classTokens

array

$nameInformation

\Zend\Code\NameInformationnull

Returns

\Zend\Code\Scanner\ClassScanner

__toString()

__toString() 
Inherited

export()

export() 
InheritedStatic

Get annotations

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

Parameters

$annotationManager

\Zend\Code\Annotation\AnnotationManager

Returns

\Zend\Code\Annotation\AnnotationCollection

Return a single constant by given name or index of info

getConstant(string|integer $constantNameOrInfoIndex) : boolean | \Zend\Code\Scanner\ConstantScanner
inherited_from \Zend\Code\Scanner\ClassScanner::getConstant()

Parameters

$constantNameOrInfoIndex

stringinteger

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

boolean\Zend\Code\Scanner\ConstantScanner

Return a single constant by given name or index of info

getConstant(string|integer $constantNameOrInfoIndex) : boolean | \Zend\Code\Scanner\ConstantScanner
Inherited

Parameters

$constantNameOrInfoIndex

stringinteger

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

boolean\Zend\Code\Scanner\ConstantScanner

Return a list of constant names

getConstantNames() : array
inherited_from \Zend\Code\Scanner\ClassScanner::getConstantNames()

Returns

array

Return a list of constant names

getConstantNames() : array
Inherited

Returns

array

Return a list of constants

getConstants(boolean $namesOnly = true) : array | array<mixed,\Zend\Code\Scanner\ConstantScanner>
inherited_from \Zend\Code\Scanner\ClassScanner::getConstants()

Parameters

$namesOnly

boolean

Set false to return instances of ConstantScanner

Returns

arrayarray<mixed,\Zend\Code\Scanner\ConstantScanner>

Return a list of constants

getConstants(boolean $namesOnly = true) : array | array<mixed,\Zend\Code\Scanner\ConstantScanner>
Inherited

Parameters

$namesOnly

boolean

Set false to return instances of ConstantScanner

Returns

arrayarray<mixed,\Zend\Code\Scanner\ConstantScanner>

Return documentation block

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

Returns

false\Zend\Code\Scanner\DocBlockScanner

Return documentation comment

getDocComment() : null | string
Inherited

Returns

nullstring

Return a list of interface names

getInterfaces(boolean $returnClassScanners = false) : array
inherited_from \Zend\Code\Scanner\ClassScanner::getInterfaces()

Parameters

$returnClassScanners

boolean

Returns

array

Return a list of interface names

getInterfaces() : array
Inherited

Returns

array

Return number of last line

getLineEnd() : integer | null
Inherited

Returns

integernull

Return number of first line

getLineStart() : integer | null
Inherited

Returns

integernull

Return a single method by given name or index of info

getMethod(integer|string $methodNameOrInfoIndex) : \Zend\Code\Scanner\MethodScanner
inherited_from \Zend\Code\Scanner\ClassScanner::getMethod()

Parameters

$methodNameOrInfoIndex

integerstring

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

\Zend\Code\Scanner\MethodScanner

Return a single method by given name or index of info

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

Parameters

$methodNameOrInfoIndex

stringinteger

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

\Zend\Code\Scanner\MethodScanner

Return a list of method names

getMethodNames() : array
inherited_from \Zend\Code\Scanner\ClassScanner::getMethodNames()

Returns

array

Return a list of method names

getMethodNames() : array
Inherited

Returns

array

Return a list of methods

getMethods() : array<mixed,\Zend\Code\Scanner\MethodScanner>
inherited_from \Zend\Code\Scanner\ClassScanner::getMethods()

Returns

array<mixed,\Zend\Code\Scanner\MethodScanner>

Return a list of methods

getMethods() : array<mixed,\Zend\Code\Scanner\MethodScanner>
Inherited

Returns

array<mixed,\Zend\Code\Scanner\MethodScanner>

Return a name of class

getName() : null | string
inherited_from \Zend\Code\Scanner\ClassScanner::getName()

Returns

nullstring

Return a name of class

getName() : null | string
Inherited

Returns

nullstring

Return a name of parent class

getParentClass() : null | string
inherited_from \Zend\Code\Scanner\ClassScanner::getParentClass()

Returns

nullstring

Return a name of parent class

getParentClass() : null | string
Inherited

Returns

nullstring

getParentClasses()

getParentClasses() : array

Returns

array

Return a list of properties

getProperties(boolean $returnScannerProperty = false) : array
inherited_from \Zend\Code\Scanner\ClassScanner::getProperties()

Parameters

$returnScannerProperty

boolean

Returns

array

Return a list of properties

getProperties() : array<mixed,\Zend\Code\Scanner\PropertyScanner>
Inherited

Returns

array<mixed,\Zend\Code\Scanner\PropertyScanner>

Return a single property by given name or index of info

getProperty(string|integer $propertyNameOrInfoIndex) : boolean | \Zend\Code\Scanner\PropertyScanner
inherited_from \Zend\Code\Scanner\ClassScanner::getProperty()

Parameters

$propertyNameOrInfoIndex

stringinteger

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

boolean\Zend\Code\Scanner\PropertyScanner

Return a single property by given name or index of info

getProperty(string|integer $propertyNameOrInfoIndex) : boolean | \Zend\Code\Scanner\PropertyScanner
Inherited

Parameters

$propertyNameOrInfoIndex

stringinteger

Exceptions

\Zend\Code\Exception\InvalidArgumentException

Returns

boolean\Zend\Code\Scanner\PropertyScanner

Return a list of property names

getPropertyNames() : array
inherited_from \Zend\Code\Scanner\ClassScanner::getPropertyNames()

Returns

array

Return a list of property names

getPropertyNames() : array
Inherited

Returns

array

Return short name of class

getShortName() : null | string
inherited_from \Zend\Code\Scanner\ClassScanner::getShortName()

Returns

nullstring

Return short name of class

getShortName() : null | string
Inherited

Returns

nullstring

Retrieve a list of aliased traits used by the class.

getTraitAliases() : array
Inherited

Returns

array

Retrieve a list of trait names used by this class.

getTraitNames() : array
Inherited

Returns

array

Retrieve any traits used by the class.

getTraits() : array<mixed,\Zend\Code\Scanner\ClassScanner>
Inherited

Returns

array<mixed,\Zend\Code\Scanner\ClassScanner>

Verify if class or parent class has constant

hasConstant(string $name) : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::hasConstant()

Parameters

$name

string

Returns

boolean

Verify if class has constant

hasConstant(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

Verify if class or parent class has method by given name

hasMethod(string $name) : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::hasMethod()

Parameters

$name

string

Returns

boolean

Verify if class has method by given name

hasMethod(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

Verify if class has parent

hasParentClass() : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::hasParentClass()

Returns

boolean

Verify if class has parent

hasParentClass() : boolean
Inherited

Returns

boolean

Verify if class or parent class has property

hasProperty(string $name) : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::hasProperty()

Parameters

$name

string

Returns

boolean

Verify if class has property

hasProperty(string $name) : boolean
Inherited

Parameters

$name

string

Returns

boolean

Verify if class is an abstract class

isAbstract() : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::isAbstract()

Returns

boolean

Verify if class is an abstract class

isAbstract() : boolean
Inherited

Returns

boolean

Verify if class is final

isFinal() : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::isFinal()

Returns

boolean

Verify if class is final

isFinal() : boolean
Inherited

Returns

boolean

Verify if class is instantiable

isInstantiable() : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::isInstantiable()

Returns

boolean

Verify if class is instantiable

isInstantiable() : boolean
Inherited

Returns

boolean

Verify if class is an interface

isInterface() : boolean
inherited_from \Zend\Code\Scanner\ClassScanner::isInterface()

Returns

boolean

Verify if class is an interface

isInterface() : boolean
Inherited

Returns

boolean

Verify if class is a trait

isTrait() : boolean
Inherited

Returns

boolean

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

getBlockedTraitMethods() : array
Inherited

Returns

array

Retrieve visibility for a given alias.

getVisibilityForAlias(mixed $aliasName) : string
Inherited

Parameters

$aliasName

mixed

Returns

string

Scan tokens

scan() : void
Inherited

Exceptions

\Zend\Code\Exception\RuntimeException

 Properties

 

$classScanner

$classScanner : \Zend\Code\Scanner\ClassScanner

Default

null
 

$directoryScanner

$directoryScanner : \Zend\Code\Scanner\DirectoryScanner

Default

null
 

$docComment

$docComment : string

Default

null
 

$infos

$infos : array

Default

array()
 

$interfaceClassScanners

$interfaceClassScanners : array

Default

array()
 

$interfaces

$interfaces : array

Default

array()
 

$isAbstract

$isAbstract : boolean

Default

false
 

$isFinal

$isFinal : boolean

Default

false
 

$isInterface

$isInterface : boolean

Default

false
 

$isScanned

$isScanned : boolean

Default

false
 

$isTrait

$isTrait : boolean

Default

false
 

$lineEnd

$lineEnd : integer

Default

null
 

$lineStart

$lineStart : integer

Default

null
 

$methods

$methods : array

Default

array()
 

$name

$name : string

Default

null
 

$nameInformation

$nameInformation : \Zend\Code\NameInformation

Default

null
 

$parentClass

$parentClass : string

Default

null
 

$parentClassScanners

$parentClassScanners : array

Default

array()
 

$shortInterfaces

$shortInterfaces : array

Default

array()
 

$shortName

$shortName : string

Default

null
 

$shortParentClass

$shortParentClass : string

Default

null
 

$tokens

$tokens : array

Default

array()
 

$traits

$traits : array

Default

array()