1
0
mirror of https://github.com/danog/class-finder.git synced 2024-11-26 20:14:59 +01:00
Go to file
Hayden Pierce a62f18ef33 Merge branch 'files' into 'master'
Files Support

See merge request hpierce1102/ClassFinder!3
2018-11-24 17:01:57 +00:00
ci Update CI to run on all tests 2018-09-08 21:07:36 -05:00
docs Add "Experimental" to the flag. 2018-11-24 10:14:55 -06:00
src Add "Experimental" to the flag. 2018-11-24 10:14:55 -06:00
test Add test case to test for 3rd party files 2018-11-24 10:52:01 -06:00
.gitlab-ci.yml Get more interesting information first. 2018-09-03 16:30:30 -05:00
composer.json Bump composer version. 2018-09-23 12:59:52 -05:00
composer.lock Update composer lock files. 2018-09-22 15:24:53 -05:00
LICENSE Add license 2018-07-28 14:45:27 -05:00
phpunit.xml Include file integration tests in all test suites 2018-10-21 15:34:30 -05:00
README.md Update documentation 2018-11-24 10:56:55 -06:00

ClassFinder

A dead simple utility to identify classes in a given namespace. This package is an improved implementation of an answer on Stack Overflow that 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 haydenpierce/class-finder

No other installation methods are currently supported.

Supported Autoloading Methods

  • PSR-4
  • Classmaps
  • Files (Experimental, must be explicitly enabled via ClassFinder::enableExperimentalFilesSupport())

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

Exceptions:

Internals

Roadmap

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.

0.0.1 - First party psr4 classes

0.1.0 - Third party psr4 classes

0.2.0 - classmap support.

0.3.0 - files support

0.4.0 - psr0 support

0.5.0 - Additional features:

Various ideas:

  • 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.

1.0.0 - Better compliance with semantic versioning.