FileScanner
extends TokenArrayScanner
in package
implements
ScannerInterface
Interfaces, Classes, Traits and Enums
Table of Contents
- $annotationManager : AnnotationManager
- $docComment : null
- $file : string
- $infos : array<string|int, mixed>
- $isScanned : bool
- $nameInformation : NameInformation
- $tokens : array<string|int, mixed>
- __construct() : mixed
- __toString() : mixed
- export() : mixed
- Export
- getAnnotationManager() : AnnotationManager
- getClass() : ClassScanner|false
- Return the class object from this scanner
- getClasses() : array<string|int, ClassScanner>
- getClassNameInformation() : bool|null|NameInformation
- getClassNames() : array<string|int, mixed>
- getDocComment() : string|null
- Get doc comment
- getFile() : string
- getFunctionNames() : array<string|int, mixed>
- getFunctions() : array<string|int, mixed>
- getIncludes() : void
- getNamespaces() : array<string|int, mixed>
- getUses() : array<string|int, mixed>|null
- hasNamespace() : bool
- Check for namespace
- getUsesNoScan() : null|array<string|int, mixed>
- scan() : mixed
- Scan
Properties
$annotationManager
protected
AnnotationManager
$annotationManager
$docComment
protected
null
$docComment
$file
protected
string
$file
$infos
protected
array<string|int, mixed>
$infos
= []
$isScanned
protected
bool
$isScanned
= false
$nameInformation
protected
NameInformation
$nameInformation
$tokens
protected
array<string|int, mixed>
$tokens
= []
Methods
__construct()
public
__construct(string $file[, null|AnnotationManager $annotationManager = null ]) : mixed
Parameters
- $file : string
- $annotationManager : null|AnnotationManager = null
Tags
Return values
mixed —__toString()
public
__toString() : mixed
Return values
mixed —export()
Export
public
static export(mixed $tokens) : mixed
Parameters
- $tokens : mixed
Return values
mixed —getAnnotationManager()
public
getAnnotationManager() : AnnotationManager
Return values
AnnotationManager —getClass()
Return the class object from this scanner
public
getClass(string|int $name) : ClassScanner|false
Parameters
- $name : string|int
Tags
Return values
ClassScanner|false —getClasses()
public
getClasses() : array<string|int, ClassScanner>
Return values
array<string|int, ClassScanner> —getClassNameInformation()
public
getClassNameInformation(string $className) : bool|null|NameInformation
Parameters
- $className : string
Return values
bool|null|NameInformation —getClassNames()
public
getClassNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getDocComment()
Get doc comment
public
getDocComment() : string|null
Tags
Return values
string|null —getFile()
public
getFile() : string
Return values
string —getFunctionNames()
public
getFunctionNames() : array<string|int, mixed>
Return values
array<string|int, mixed> —getFunctions()
public
getFunctions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getIncludes()
public
getIncludes() : void
Return values
void —getNamespaces()
public
getNamespaces() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUses()
public
getUses([null|string $namespace = null ]) : array<string|int, mixed>|null
Parameters
- $namespace : null|string = null
Return values
array<string|int, mixed>|null —hasNamespace()
Check for namespace
public
hasNamespace(string $namespace) : bool
Parameters
- $namespace : string
Return values
bool —getUsesNoScan()
protected
getUsesNoScan(string $namespace) : null|array<string|int, mixed>
Parameters
- $namespace : string
Tags
Return values
null|array<string|int, mixed> —scan()
Scan
protected
scan() : mixed