ClassScanner
in package
implements
ScannerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $docComment : string
- $infos : array<string|int, mixed>
- $interfaces : array<string|int, mixed>
- $isAbstract : bool
- $isFinal : bool
- $isInterface : bool
- $isScanned : bool
- $isTrait : bool
- $lineEnd : int
- $lineStart : int
- $methods : array<string|int, mixed>
- $name : string
- $nameInformation : NameInformation
- $parentClass : string
- $shortInterfaces : array<string|int, mixed>
- $shortName : string
- $shortParentClass : string
- $tokens : array<string|int, mixed>
- $traits : array<string|int, mixed>
- __construct() : ClassScanner
- __toString() : mixed
- export() : mixed
- getAnnotations() : AnnotationCollection
- Get annotations
- getConstant() : bool|ConstantScanner
- Return a single constant by given name or index of info
- getConstantNames() : array<string|int, mixed>
- Return a list of constant names
- getConstants() : array<string|int, mixed>|array<string|int, ConstantScanner>
- Return a list of constants
- getDocBlock() : false|DocBlockScanner
- Return documentation block
- getDocComment() : null|string
- Return documentation comment
- getInterfaces() : array<string|int, mixed>
- Return a list of interface names
- getLineEnd() : int|null
- Return number of last line
- getLineStart() : int|null
- Return number of first line
- getMethod() : MethodScanner
- Return a single method by given name or index of info
- getMethodNames() : array<string|int, mixed>
- Return a list of method names
- getMethods() : array<string|int, MethodScanner>
- Return a list of methods
- getName() : null|string
- Return a name of class
- getParentClass() : null|string
- Return a name of parent class
- getProperties() : array<string|int, PropertyScanner>
- Return a list of properties
- getProperty() : bool|PropertyScanner
- Return a single property by given name or index of info
- getPropertyNames() : array<string|int, mixed>
- Return a list of property names
- getShortName() : null|string
- Return short name of class
- getTraitAliases() : array<string|int, mixed>
- Retrieve a list of aliased traits used by the class.
- getTraitNames() : array<string|int, mixed>
- Retrieve a list of trait names used by this class.
- getTraits() : array<string|int, ClassScanner>
- Retrieve any traits used by the class.
- hasConstant() : bool
- Verify if class has constant
- hasMethod() : bool
- Verify if class has method by given name
- hasParentClass() : bool
- Verify if class has parent
- hasProperty() : bool
- Verify if class has property
- isAbstract() : bool
- Verify if class is an abstract class
- isFinal() : bool
- Verify if class is final
- isInstantiable() : bool
- Verify if class is instantiable
- isInterface() : bool
- Verify if class is an interface
- isTrait() : bool
- Verify if class is a trait
- getBlockedTraitMethods() : array<string|int, mixed>
- Return an array of key = trait to keep, value = trait::method to ignore
- getVisibilityForAlias() : string
- Retrieve visibility for a given alias.
- scan() : void
- Scan tokens
Properties
$docComment
protected
string
$docComment
$infos
protected
array<string|int, mixed>
$infos
= []
$interfaces
protected
array<string|int, mixed>
$interfaces
= []
$isAbstract
protected
bool
$isAbstract
= false
$isFinal
protected
bool
$isFinal
= false
$isInterface
protected
bool
$isInterface
= false
$isScanned
protected
bool
$isScanned
= false
$isTrait
protected
bool
$isTrait
= false
$lineEnd
protected
int
$lineEnd
$lineStart
protected
int
$lineStart
$methods
protected
array<string|int, mixed>
$methods
= []
$name
protected
string
$name
$nameInformation
protected
NameInformation
$nameInformation
$parentClass
protected
string
$parentClass
$shortInterfaces
protected
array<string|int, mixed>
$shortInterfaces
= []
$shortName
protected
string
$shortName
$shortParentClass
protected
string
$shortParentClass
$tokens
protected
array<string|int, mixed>
$tokens
= []
$traits
protected
array<string|int, mixed>
$traits
= []
Methods
__construct()
public
__construct(array<string|int, mixed> $classTokens[, NameInformation|null $nameInformation = null ]) : ClassScanner
Parameters
- $classTokens : array<string|int, mixed>
- $nameInformation : NameInformation|null = null
Return values
ClassScanner —__toString()
public
__toString() : mixed
Return values
mixed —export()
public
static export() : mixed
Return values
mixed —getAnnotations()
Get annotations
public
getAnnotations(AnnotationManager $annotationManager) : AnnotationCollection
Parameters
- $annotationManager : AnnotationManager
Return values
AnnotationCollection —getConstant()
Return a single constant by given name or index of info
public
getConstant(string|int $constantNameOrInfoIndex) : bool|ConstantScanner
Parameters
- $constantNameOrInfoIndex : string|int
Tags
Return values
bool|ConstantScanner —getConstantNames()
Return a list of constant names
public
getConstantNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getConstants()
Return a list of constants
public
getConstants([bool $namesOnly = true ]) : array<string|int, mixed>|array<string|int, ConstantScanner>
Parameters
- $namesOnly : bool = true
-
Set false to return instances of ConstantScanner
Return values
array<string|int, mixed>|array<string|int, ConstantScanner> —getDocBlock()
Return documentation block
public
getDocBlock() : false|DocBlockScanner
Return values
false|DocBlockScanner —getDocComment()
Return documentation comment
public
getDocComment() : null|string
Return values
null|string —getInterfaces()
Return a list of interface names
public
getInterfaces() : array<string|int, mixed>
Return values
array<string|int, mixed> —getLineEnd()
Return number of last line
public
getLineEnd() : int|null
Return values
int|null —getLineStart()
Return number of first line
public
getLineStart() : int|null
Return values
int|null —getMethod()
Return a single method by given name or index of info
public
getMethod(string|int $methodNameOrInfoIndex) : MethodScanner
Parameters
- $methodNameOrInfoIndex : string|int
Tags
Return values
MethodScanner —getMethodNames()
Return a list of method names
public
getMethodNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMethods()
Return a list of methods
public
getMethods() : array<string|int, MethodScanner>
Return values
array<string|int, MethodScanner> —getName()
Return a name of class
public
getName() : null|string
Return values
null|string —getParentClass()
Return a name of parent class
public
getParentClass() : null|string
Return values
null|string —getProperties()
Return a list of properties
public
getProperties() : array<string|int, PropertyScanner>
Return values
array<string|int, PropertyScanner> —getProperty()
Return a single property by given name or index of info
public
getProperty(string|int $propertyNameOrInfoIndex) : bool|PropertyScanner
Parameters
- $propertyNameOrInfoIndex : string|int
Tags
Return values
bool|PropertyScanner —getPropertyNames()
Return a list of property names
public
getPropertyNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getShortName()
Return short name of class
public
getShortName() : null|string
Return values
null|string —getTraitAliases()
Retrieve a list of aliased traits used by the class.
public
getTraitAliases() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTraitNames()
Retrieve a list of trait names used by this class.
public
getTraitNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getTraits()
Retrieve any traits used by the class.
public
getTraits() : array<string|int, ClassScanner>
Return values
array<string|int, ClassScanner> —hasConstant()
Verify if class has constant
public
hasConstant(string $name) : bool
Parameters
- $name : string
Return values
bool —hasMethod()
Verify if class has method by given name
public
hasMethod(string $name) : bool
Parameters
- $name : string
Return values
bool —hasParentClass()
Verify if class has parent
public
hasParentClass() : bool
Return values
bool —hasProperty()
Verify if class has property
public
hasProperty(string $name) : bool
Parameters
- $name : string
Return values
bool —isAbstract()
Verify if class is an abstract class
public
isAbstract() : bool
Return values
bool —isFinal()
Verify if class is final
public
isFinal() : bool
Return values
bool —isInstantiable()
Verify if class is instantiable
public
isInstantiable() : bool
Return values
bool —isInterface()
Verify if class is an interface
public
isInterface() : bool
Return values
bool —isTrait()
Verify if class is a trait
public
isTrait() : bool
Return values
bool —getBlockedTraitMethods()
Return an array of key = trait to keep, value = trait::method to ignore
protected
getBlockedTraitMethods() : array<string|int, mixed>
Return values
array<string|int, mixed> —getVisibilityForAlias()
Retrieve visibility for a given alias.
protected
getVisibilityForAlias(mixed $aliasName) : string
Parameters
- $aliasName : mixed
Return values
string —scan()
Scan tokens
protected
scan() : void