synga/inheritance-finder

This package can find classes which are extended, implemented by a certain class or is using a certain trait.

Maintainers

Details

github.com/synga-nl/inheritance-finder

Source

Issues

Installs: 861

Dependents: 3

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

1.0.9 2016-05-08 15:35 UTC

Requires

Requires (Dev)

MIT 52669ac662b58dfeb6142b2e1bffbfba6f17d4b0

This package is auto-updated.

Last update: 2024-03-26 03:46:35 UTC

README

This package can find classes which are extended, implemented or is using a certain trait. It builds a cache and uses it to find the desired files.

##Usage

$config = new \Synga\InheritanceFinder\File\FileConfig();
$config->setApplicationRoot(__DIR__);
$config->setCacheDirectory(__DIR__);

$inheritanceFinder = Synga\InheritanceFinder\InheritanceFinderFactory::getInheritanceFinder($config);
$inheritanceFinder->findExtends('SomeNamespace\OtherNamespacePath\Class');

It will now find all classes which inherit from class SomeNamespace\OtherNamespacePath\Class whithin your ApplicationRoot directory

##Possible options:

  • findClass('full qualified namespace') - Can locate a file with the given namespace in the given directory
  • findExtends('full qualified namespace') - Can locate multiple classes which inherit from the given class in the given directory
  • findImplements('full qualified namespace') - Can locate multiple classes which implement or inherit from the given interface in the given directory
  • findTraitUse('full qualified namespace') - Can locate multiple classes which uses the given trait in the given directory
  • findMultiple('Classes [string or array of strings]', 'Interfaces [string or array of strings]', 'Traits [string or array of strings]') - Can locate multiple classes at once, it uses the methods discribed above.

##Acknowledgements:

  • Right now this package cannot handle multiple classes in one file. I will try to fix this in the near future.
  • The first run will be slow, because it is indexing all the files in your project root. I'm thinking off a manner to make it faster. I am planning of using react php for this so we can use multiple processes.
  • Don't use this code in production (you can use it FOR production, to build a cache of files). The performance results are strongly depending your hardware.