Find definitions in PHP or Hack files. Useful for autoloaders.
This library finds all the definitions in a file or tree that HHVM understands. It is used to generate the Hack reference documentation, and be used for other purposes such as generating autoload maps
This project requires HHVM 3.9 or later - however, if the code being scanned requires a later version of HHVM, definition-finder may not be able to parse it on the lower version.
There are three main entrypoints:
FileParser::FromData(string $data, ?string $filename = null)
FileParser returns definitions from a single file, whereas
TreeParser recurses over an entire directory tree. All 3 of these functions return an implementation of
BaseParser. There are three forms of accessors:
getClasses(): vec<ScannedClass>- returns a
ScannedClass](src/definitions/ScannedClass.php], which has a similar interface to
getClassNames(): vec<string>- returns a
vecof class names
getClass(string $name): ScannedClass- returns a
ScannedClassfor the specified class, or throws an exception if it was not found
Similar functions exist for interfaces, traits, constants, enums, and typedefs.
hhvm composer require facebook/definition-finder
The API is stable, and this is used in production to generate the Hack reference documentation.
This is a recursive parser built on the token stream exposed by
We welcome GitHub issues and pull requests - please see CONTRIBUTING.md for details.
definition-finder is MIT-licensed.