https://github.com/danog/class-finder
Fork of haydenpierce/class-finder with support for traits and interfaces
https://github.com/danog/class-finder
Last synced: 10 months ago
JSON representation
Fork of haydenpierce/class-finder with support for traits and interfaces
- Host: GitHub
- URL: https://github.com/danog/class-finder
- Owner: danog
- License: mit
- Created: 2020-10-11T16:22:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-15T17:05:43.000Z (almost 6 years ago)
- Last Synced: 2025-02-01T11:11:08.393Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 189 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ClassFinder
===========
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](https://stackoverflow.com/a/40229665/3000068)
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
--------------------------------
| Method | Supported | with `ClassFinder::RECURSIVE_MODE` |
| ---------- | --------- | ---------------------------------- |
| PSR-4 | ✔️ | ✔️ |
| PSR-0 | ❌️* | ❌️* |
| Classmap | ✔️ | ✔️ |
| Files | ✔️^ | ❌️** |
\^ Experimental.
\* Planned.
\** Not planned. Open an issue if you need this feature.
Examples
--------
**Standard Mode**
```
**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:
* ~~`ClassFinder::getClassesInNamespace('TestApp1\Foo', ClassFinder::RECURSIVE_MODE)`.
Providing classes multiple namespaces deep.~~ (included v0.3-beta)
* `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.