mirror of
https://github.com/danog/class-finder.git
synced 2024-12-02 09:27:48 +01:00
67 lines
1.4 KiB
Markdown
67 lines
1.4 KiB
Markdown
ClassFinder
|
|
===========
|
|
|
|
A lightweight utility to identify classes in a given namespace. This package is an improved implementation of an
|
|
[answer on Stack Overflow](https://stackoverflow.com/a/40229665/3000068) that provides additional features with less
|
|
configuration required.
|
|
|
|
Requirements
|
|
------------
|
|
|
|
* Application is using Composer.
|
|
* Classes are compliant with PSR-4.
|
|
* PHP >= 5.3.0
|
|
|
|
Known Limitations
|
|
-----------------
|
|
|
|
* ClassFinder can only identify classes autoloaded with PSR-4. PSR-0, classmaps, and files are not supported.
|
|
|
|
These limitations may eventually be fixed.
|
|
|
|
Installing
|
|
----------
|
|
|
|
Installing is done by requiring it with Composer.
|
|
|
|
```
|
|
$ composer require haydenpierce/class-finder
|
|
```
|
|
|
|
No other installation methods are currently supported.
|
|
|
|
Example
|
|
-------
|
|
|
|
```
|
|
<?php
|
|
|
|
require_once __DIR__ . '/vendor/autoload.php';
|
|
|
|
$classes = ClassFinder::getClassesInNamespace('TestApp1\Foo');
|
|
|
|
/**
|
|
* array(
|
|
* 'TestApp1\Foo\Bar',
|
|
* 'TestApp1\Foo\Baz',
|
|
* 'TestApp1\Foo\Foo'
|
|
* )
|
|
*/
|
|
var_dump($classes);
|
|
```
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
[Changelog](docs/changelog.md)
|
|
|
|
**Exceptions**:
|
|
|
|
* [Unknown namespace - (Unregistered)](docs/exceptions/unregisteredRoot.md)
|
|
* [Unknown namespace - (Registered)](docs/exceptions/unknownSubNamespace.md)
|
|
* [Missing composer.json](docs/exceptions/missingComposerConfig.md)
|
|
|
|
**Internals**
|
|
|
|
* [How Testing Works](docs/testing.md)
|
|
* [Continuous Integration Notes](docs/ci.md) |