kilahm / hack-class-scanner
Recursively scan a directory for hack classes and/or interfaces
Installs: 116
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 0
Forks: 0
Open Issues: 0
Language:Hack
Requires (Dev)
- hackpack/hackunit: 0.3.*
README
A class that recursively scans a directory for hack classes.
Installation
Add the following line to your composer.json
file in the require
section.
“kilahm/hack-class-scanner”: “dev-master”
Then run composer update
.
Use
To use the class, simply instantiate it with a set of base directories to scan and a set of directories to ignore.
use kilahm\Scanner\ClassScanner; $scanner = new ClassScanner( Set{‘directory/to/scan’, ‘other/directory’}, Set{‘other/directory/to/ignore’} ); $classMap = $scanner->mapClassToFile(); $classAndInterfaceMap = $scanner->mapClassOrInterfaceToFile();
The $classMap
variable will then hold a Map<string,string>
object that maps class names (with full namespace) to the files in which the class is defined.
The $classAndInterfaceMap
will be the same as $classMap
except it will include interfaces as well as classes.
Filters
You can filter the result files based on the name of the class or the name of the file. A filter must be a closure with a signature of function(string) : bool
.
The input for a class filter is the name of the class including the namespace. The input for a file filter is the name of the file including the full path (via realpath
).
If all registered filter functions return true
for a particular file or class name, the file will be scanned for a class and the class name will appear in the output, respectively.
$includes = Set{...}; $excludes = Set{...}; $scanner = new ClassScanner($includes, $excludes); $classFilter = $className ==> preg_match(‘/pattern/’, $className); $fileFilter = $fileName ==> preg_match(‘/pattern/’, $fileName); $scanner->addClassNameFilter($classFilter); $scanner->addFileNameFilter($fileFilter); $classMap = $scanner->mapClassToFile();
Assumptions
This class assumes you are following the practice of one class per file. The scanner will stop searching once it has found the first class name in a file.
Thanks
The file parsing algorithm was heavily influenced by the one used in HackPack/HackUnit.