This project provides a composer package with a finder for classy constructs (classes, enums, interfaces, and traits).
Run
composer require ergebnis/classyThis package provides the following collectors for finding classy constructs:
Ergebnis\Classy\Collector\TokenGetAllConstructFromSourceCollectorErgebnis\Classy\Collector\PhpTokenTokenizeConstructFromSourceCollectorErgebnis\Classy\Collector\DefaultConstructFromFileCollectorErgebnis\Classy\Collector\DefaultConstructFromSplFileInfoCollectorErgebnis\Classy\Collector\DefaultConstructFromFinderCollector
Use Collector\TokenGetAllConstructFromSourceCollector to collect classy constructs from source code on PHP 7:
declare(strict_types=1);
use Ergebnis\Classy;
$source = Classy\Source::fromString(<<<'PHP'
namespace Example;
class Foo {}
enum Bar {}
interface Baz {}
trait Qux {}
PHP);
$collector = new Classy\Collector\TokenGetAllConstructFromSourceCollector();
$constructs = $collector->collectFromSource($source);
foreach ($constructs as $construct) {
/** @var Classy\Construct $construct */
echo sprintf(
"- %s (%s)\n",
$construct->name()->toString(),
$construct->type()->toString(),
);
}
// - Example\Foo (class)
// - Example\Bar (enum)
// - Example\Baz (interface)
// - Example\Qux (trait)Use Collector\PhpTokenTokenizeConstructFromSourceCollector to collect classy constructs from source code on PHP 8:
declare(strict_types=1);
use Ergebnis\Classy;
$source = Classy\Source::fromString(<<<'PHP'
namespace Example;
class Foo {}
enum Bar {}
interface Baz {}
trait Qux {}
PHP);
$collector = new Classy\Collector\PhpTokenTokenizeConstructFromSourceCollector();
$constructs = $collector->collectFromSource($source);
foreach ($constructs as $construct) {
/** @var Classy\Construct $construct */
echo sprintf(
"- %s (%s)\n",
$construct->name()->toString(),
$construct->type()->toString(),
);
}
// - Example\Foo (class)
// - Example\Bar (enum)
// - Example\Baz (interface)
// - Example\Qux (trait)Use Collector\DefaultConstructFromFileCollector to collect classy constructs from a file:
declare(strict_types=1);
use Ergebnis\Classy;
$filePath = Classy\FilePath::fromString(__DIR__ . '/example.php');
$collector = new Classy\Collector\DefaultConstructFromFilePathCollector(new Classy\Collector\TokenGetAllConstructFromSourceCollector());
$constructs = $collector->collectFromFilePath($filePath);
foreach ($constructs as $construct) {
/** @var Classy\Construct $construct */
echo sprintf(
"- %s (%s)\n",
$construct->name()->toString(),
$construct->type()->toString(),
);
}
// - Example\Foo (class)
// - Example\Bar (enum)
// - Example\Baz (interface)
// - Example\Qux (trait)Use Collector\DefaultConstructFromSplFileInfoCollector to collect classy constructs from an instance of SplFileInfo:
declare(strict_types=1);
use Ergebnis\Classy;
$splFileInfo = new \SplFileInfo(__DIR__ . '/example.php');
$collector = new Classy\Collector\DefaultConstructFromSplFileInfoCollector(new Classy\Collector\TokenGetAllConstructFromSourceCollector());
$constructs = $collector->collectFromSplFileInfo($splFileInfo);
foreach ($constructs as $construct) {
/** @var Classy\Construct $construct */
echo sprintf(
"- %s (%s)\n",
$construct->name()->toString(),
$construct->type()->toString(),
);
}
// - Example\Foo (class)
// - Example\Bar (enum)
// - Example\Baz (interface)
// - Example\Qux (trait)Use Collector\DefaultConstructFromFinderCollector to collect classy constructs from an iterable of SplFileInfo:
declare(strict_types=1);
use Ergebnis\Classy;
use Symfony\Component\Finder;
$finder = Finder\Finder::create()
->files()
->in(__DIR__ . '/src');
$collector = new Classy\Collector\DefaultConstructFromFinderCollector(new Classy\Collector\TokenGetAllConstructFromSourceCollector()));
$constructs = $collector->collectFromFinder($finder);
foreach ($constructs as $construct) {
/** @var Classy\Construct $construct */
echo sprintf(
"- %s (%s)\n",
$construct->name()->toString(),
$construct->type()->toString(),
);
}
// - Example\Foo (class)
// - Example\Bar (enum)
// - Example\Baz (interface)
// - Example\Qux (trait)The maintainers of this project record notable changes to this project in a changelog.
The maintainers of this project suggest following the contribution guide.
The maintainers of this project ask contributors to follow the code of conduct.
The maintainers of this project provide limited support.
This project currently supports the following PHP versions:
- PHP 7.4 (has reached its end of life on November 28, 2022)
- PHP 8.0 (has reached its end of life on November 26, 2023)
- PHP 8.1 (has reached its end of life on December 31, 2025)
- PHP 8.2
- PHP 8.3
- PHP 8.4
- PHP 8.5
The maintainers of this project add support for a PHP version following its initial release and may drop support for a PHP version when it has reached its end of life.
This project has a security policy.
This project uses the MIT license.
The algorithm for finding classes in PHP files in Constructs has been adopted from Zend\File\ClassFileLocator (originally licensed under BSD-3-Clause).
Follow @localheinz and @ergebnis on X.