Locator class
Framework\Autoload\Locator
Class Locator.
The Locator class has methods for finding files and the class FQN using an
Autoloader instance.
Defined in libraries/autoload/src/Locator.php
Properties #
$autoloader
protected \Framework\Autoload\Autoloader $autoloader
Methods #
- __construct()
- Locator constructor.
- findFiles()
- Find namesake files inside namespaced directories.
- getClassName()
- Gets the first Qualified Class Name in a given filename.
- getFiles()
- Get a list of all files inside namespaced sub directories.
- getNamespacedFilepath()
- Get the first filepath found in all namespaces.
- listFiles()
- Get a list of all files inside a directory.
- ensureExtension()
- -
__construct()
public function __construct(\Framework\Autoload\Autoloader $autoloader)
Locator constructor.
Parameters
- \Framework\Autoload\Autoloader $autoloader
findFiles()
public function findFiles(string $filename, string $extension = '.php'): array
Find namesake files inside namespaced directories.
Parameters
- string $filename - The file name
- string $extension - The file extension
Returns
array
- An array of filenames found
getClassName()
public function getClassName(string $filename): ?string
Gets the first Qualified Class Name in a given filename.
The "class name" can be the name of a class, an interface or a trait.
Parameters
- string $filename
Returns
?string
- The class name or null if not found
getFiles()
public function getFiles(string $subDirectory): array
Get a list of all files inside namespaced sub directories.
Parameters
- string $subDirectory - Sub directory path
Returns
array
getNamespacedFilepath()
public function getNamespacedFilepath(string $file, string $extension = '.php'): ?string
Get the first filepath found in all namespaces.
Parameters
- string $file - The file name without extension
- string $extension - The file extension
Returns
?string
- The filepath or null if not found
listFiles()
public function listFiles(string $directory): ?array
Get a list of all files inside a directory.
Parameters
- string $directory - Absolute directory path
Returns
?array
- Returns an array of filenames or null if the directory can not be resolved
ensureExtension()
protected function ensureExtension(string $filename, string $extension): string
Parameters
- string $filename
- string $extension
Returns
string