Download the PHP package facebook/definition-finder without Composer
On this page you can find all versions of the php package facebook/definition-finder. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download facebook/definition-finder
More information about facebook/definition-finder
Files in facebook/definition-finder
Package definition-finder
Short Description Find definitions in PHP or Hack files. Useful for autoloaders.
License MIT
Homepage https://github.com/hhvm/definitions-finder
Informations about the package definition-finder
Definition Finder
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.
Usage
There are three main entrypoints:
FileParser::FromFile(string $filename)
FileParser::FromData(string $data, ?string $filename = null)
TreeParser::FromPath(string $path)
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 avec
of [ScannedClass
](src/definitions/ScannedClass.php], which has a similar interface toReflectionClass
getClassNames(): vec<string>
- returns avec
of class namesgetClass(string $name): ScannedClass
- returns aScannedClass
for the specified class, or throws an exception if it was not found
Similar functions exist for interfaces, traits, constants, enums, and typedefs.
Installation
Status
The API is stable, and this is used in production to generate the Hack reference documentation.
Implementation
This is a recursive parser built on the token stream exposed by token_get_all()
.
Contributing
We welcome GitHub issues and pull requests - please see CONTRIBUTING.md for details.
License
definition-finder is MIT-licensed.