danog / class-finder
Fork of haydenpierce/class-finder with support for traits, interfaces and functions
Installs: 22 170
Dependents: 2
Suggesters: 0
Security: 0
Stars: 7
Watchers: 3
Forks: 1
Open Issues: 0
Requires
- php: >=5.3
- ext-json: *
Requires (Dev)
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: 4.8.36
README
A dead simple utility to identify classes, traits, functions and interfaces in a given namespace.
This package is an improved implementation of an answer on Stack Overflow and provides additional features with less configuration required.
Requirements
- Application is using Composer.
- Classes can be autoloaded with Composer.
- PHP >= 5.3.0
Installing
Installing is done by requiring it with Composer.
$ composer require danog/class-finder
No other installation methods are currently supported.
Supported Autoloading Methods
^ Experimental.
* Planned.
** Not planned. Open an issue if you need this feature.
Examples
Standard Mode
<?php
require_once __DIR__ . '/vendor/autoload.php';
// Will default to ClassFinder::ALLOW_CLASSES
$classes = ClassFinder::getClassesInNamespace('TestApp1\Foo');
$classes = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::ALLOW_CLASSES);
$interfaces = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::ALLOW_INTERFACES);
$traits = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::ALLOW_TRAITS);
$funcs = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::ALLOW_FUNCTIONS);
// You can combine any of the flags
$interfacesTraits = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::ALLOW_TRAITS | ClassFinder::ALLOW_INTERFACES);
/**
* array(
* 'TestApp1\Foo\Bar',
* 'TestApp1\Foo\Baz',
* 'TestApp1\Foo\Foo'
* )
*/
var_dump($classes);
/**
* array(
* 'TestApp1\Foo\BarInterface',
* 'TestApp1\Foo\FooInterface'
* )
*/
var_dump($interfaces);
/**
* array(
* 'TestApp1\Foo\BazTrait',
* )
*/
var_dump($traits);
/**
* array(
* 'TestApp1\Foo\myFunc',
* )
*/
var_dump($funcs);
/**
* array(
* 'TestApp1\Foo\BarInterface',
* 'TestApp1\Foo\FooInterface',
* 'TestApp1\Foo\BazTrait',
* )
*/
var_dump($interfacesTraits);
Recursive Mode (in v0.3-beta)
<?php
require_once __DIR__ . '/vendor/autoload.php';
// As before, will default to ClassFinder::ALLOW_CLASSES
$classes = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE);
$classes = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE | ClassFinder::ALLOW_CLASSES);
$interfaces = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE | ClassFinder::ALLOW_INTERFACES);
$traits = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE | ClassFinder::ALLOW_TRAITS);
$funcs = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE | ClassFinder::ALLOW_FUNCTIONS);
// You can combine any of the flags
$classesTraits = ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE | ClassFinder::ALLOW_CLASSS | ClassFinder::ALLOW_TRAITS);
/**
* array(
* 'TestApp1\Foo\Bar',
* 'TestApp1\Foo\Baz',
* 'TestApp1\Foo\Foo',
* 'TestApp1\Foo\Box\Bar',
* 'TestApp1\Foo\Box\Baz',
* 'TestApp1\Foo\Box\Foo',
* 'TestApp1\Foo\Box\Lon\Bar',
* 'TestApp1\Foo\Box\Lon\Baz',
* 'TestApp1\Foo\Box\Lon\Foo',
* )
*/
var_dump($classes);
// You get the idea :)
var_dump($interfaces);
var_dump($traits);
var_dump($funcs);
var_dump($classesTraits);
Documentation
Exceptions:
Internals
Future Work
WARNING: Before 1.0.0, expect that bug fixes will not be backported to older versions. Backwards incompatible changes may be introduced in minor 0.X.Y versions, where X changes.
-
psr0
support -
Additional features:
Various ideas:
-
(included v0.3-beta)ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE)
. Providing classes multiple namespaces deep. -
ClassFinder::getClassesImplementingInterface('TestApp1\Foo', 'TestApp1\FooInterface', ClassFinder::RECURSIVE_MODE)
. Filtering classes to only classes that implement a namespace. -
ClassFinder::debugRenderReport('TestApp1\Foo\Baz')
Guidance for solving "class not found" errors resulting from typos in namespaces, missing directories, etc. Would print an HTML report. Not intended for production use, but debugging.