2017 © Pedro Peláez
 

library definition-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

image

facebook/definition-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  • Saturday, July 21, 2018
  • by fredemmott
  • Repository
  • 5 Watchers
  • 4 Stars
  • 11,299 Installations
  • Hack
  • 7 Dependents
  • 0 Suggesters
  • 1 Forks
  • 0 Open issues
  • 24 Versions
  • 12 % Grown

The README.md

Definition Finder

Continuous Integration, (*1)

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, (*2)

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., (*3)

Usage

There are three main entrypoints:, (*4)

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:, (*5)

  • getClasses(): vec<ScannedClass> - returns a vec of [ScannedClass](src/definitions/ScannedClass.php], which has a similar interface to ReflectionClass
  • getClassNames(): vec<string> - returns a vec of class names
  • getClass(string $name): ScannedClass - returns a ScannedClass for the specified class, or throws an exception if it was not found

Similar functions exist for interfaces, traits, constants, enums, and typedefs., (*6)

Installation

hhvm composer require facebook/definition-finder

Status

The API is stable, and this is used in production to generate the Hack reference documentation., (*7)

Implementation

This is a recursive parser built on the token stream exposed by token_get_all()., (*8)

Contributing

We welcome GitHub issues and pull requests - please see CONTRIBUTING.md for details., (*9)

License

definition-finder is MIT-licensed., (*10)

The Versions

21/07 2018

dev-master

9999999-dev https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

21/07 2018

v2.0.3

2.0.3.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

28/06 2018

v2.0.2

2.0.2.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

28/06 2018

v2.0.1

2.0.1.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

28/06 2018

v2.0.0

2.0.0.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

21/06 2018

v1.x-dev

1.9999999.9999999.9999999-dev https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

12/06 2018

v1.7.7

1.7.7.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

08/05 2018

v1.7.6

1.7.6.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

MIT

The Requires

 

The Development Requires

hack hhvm definitions autoload

06/03 2018

v1.7.5

1.7.5.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

06/03 2018

v1.7.4

1.7.4.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

03/03 2018

v1.7.3

1.7.3.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

28/02 2018

v1.7.2

1.7.2.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

09/02 2018

v1.7.1

1.7.1.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

20/01 2018

v1.7.0

1.7.0.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

 

The Development Requires

hack hhvm definitions autoload

05/01 2018

v1.6.4

1.6.4.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.23

 

The Development Requires

hack hhvm definitions autoload

11/10 2017

v1.6.3

1.6.3.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

25/08 2017

v1.6.2

1.6.2.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

14/08 2017

v1.6.1

1.6.1.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

30/06 2017

v1.6.0

1.6.0.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

24/06 2017

v1.5.2

1.5.2.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

03/05 2017

v1.5.1

1.5.1.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

17/02 2017

v1.5.0

1.5.0.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

15/02 2017

v1.4.4

1.4.4.0 https://github.com/hhvm/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload

08/02 2017

v1.4.3

1.4.3.0 https://github.com/fredemmott/definitions-finder

Find definitions in PHP or Hack files. Useful for autoloaders.

  Sources   Download

BSD-3-Clause

The Requires

  • hhvm ~3.12

 

The Development Requires

hack hhvm definitions autoload