ClassFinder
in package
implements
ClassFinderInterface
Class Finder
Tags
Interfaces, Classes and Traits
- ClassFinderInterface
- Class Finder Interface
Table of Contents
- $allowedDirectories : array<string|int, mixed>
- $availableClassesArray : array<string|int, mixed>
- $cachedResults : array<string|int, mixed>
- $dataCache : DataCache
- $disallowedDirectories : array<string|int, mixed>
- __construct() : mixed
- Constructor
- __destruct() : mixed
- Destructor
- findByInterface() : array<string|int, mixed>
- Returns an associative array with classes that implement the given interface.
- findByParent() : array<string|int, mixed>
- Returns an associative array with classes that have the given class in their parent list.
- _hasNeededParent() : bool
- Checks if $className a sub-class of $neededParentClassName
- _isLoadableClassFile() : bool
- Checks if $classFile is allowed to be included
Properties
$allowedDirectories
protected
array<string|int, mixed>
$allowedDirectories
= []
$availableClassesArray
protected
array<string|int, mixed>
$availableClassesArray
= []
$cachedResults
protected
array<string|int, mixed>
$cachedResults
$dataCache
protected
DataCache
$dataCache
$disallowedDirectories
protected
array<string|int, mixed>
$disallowedDirectories
= []
Methods
__construct()
Constructor
public
__construct(ClassFinderSettingsInterface $settings, DataCache $dataCache) : mixed
Parameters
- $settings : ClassFinderSettingsInterface
- $dataCache : DataCache
Return values
mixed —__destruct()
Destructor
public
__destruct() : mixed
Update the cache file with the latest results.
Return values
mixed —findByInterface()
Returns an associative array with classes that implement the given interface.
public
findByInterface(string $interfaceName) : array<string|int, mixed>
Array format: [ClassName] => [ClassFullFilePath]
Parameters
- $interfaceName : string
Tags
Return values
array<string|int, mixed> —findByParent()
Returns an associative array with classes that have the given class in their parent list.
public
findByParent(string $parentClassName) : array<string|int, mixed>
Array format: [ClassName] => [ClassFullFilePath]
Parameters
- $parentClassName : string
Return values
array<string|int, mixed> —_hasNeededParent()
Checks if $className a sub-class of $neededParentClassName
protected
_hasNeededParent(string $className, string $neededParentClassName) : bool
Parameters
- $className : string
- $neededParentClassName : string
Return values
bool —_isLoadableClassFile()
Checks if $classFile is allowed to be included
protected
_isLoadableClassFile(string $classFile) : bool
Parameters
- $classFile : string