README

This project provides a composer package with a finder for classy constructs (classes, enums, interfaces, and traits).

Installation

Run

composer require ergebnis/classy

Usage

This package provides the following collectors for finding classy constructs:

• Ergebnis\Classy\Collector\TokenGetAllConstructFromSourceCollector
• Ergebnis\Classy\Collector\PhpTokenTokenizeConstructFromSourceCollector
• Ergebnis\Classy\Collector\DefaultConstructFromFileCollector
• Ergebnis\Classy\Collector\DefaultConstructFromSplFileInfoCollector
• Ergebnis\Classy\Collector\DefaultConstructFromFinderCollector

Collector\TokenGetAllConstructFromSourceCollector

Use Collector\TokenGetAllConstructFromSourceCollector to collect classy constructs from source code on PHP 7:

<?php

declare(strict_types=1);

use Ergebnis\Classy;

$source = Classy\Source::fromString(<<<'PHP'
<?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)

Collector\PhpTokenTokenizeConstructFromSourceCollector

Use Collector\PhpTokenTokenizeConstructFromSourceCollector to collect classy constructs from source code on PHP 8:

<?php

declare(strict_types=1);

use Ergebnis\Classy;

$source = Classy\Source::fromString(<<<'PHP'
<?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)

Collector\DefaultConstructFromFileCollector

Use Collector\DefaultConstructFromFileCollector to collect classy constructs from a file:

<?php

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)

Collector\DefaultConstructFromSplFileInfoCollector

Use Collector\DefaultConstructFromSplFileInfoCollector to collect classy constructs from an instance of SplFileInfo:

<?php

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)

Collector\DefaultConstructFromFinderCollector

Use Collector\DefaultConstructFromFinderCollector to collect classy constructs from an iterable of SplFileInfo:

<?php

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)

Changelog

The maintainers of this project record notable changes to this project in a changelog.

Contributing

The maintainers of this project suggest following the contribution guide.

Code of Conduct

The maintainers of this project ask contributors to follow the code of conduct.

General Support Policy

The maintainers of this project provide limited support.

You can support the maintenance of this project by sponsoring @ergebnis.

PHP Version Support Policy

This project supports PHP versions with active and security support.

The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.

Security Policy

This project has a security policy.

License

This project uses the MIT license.

Credits

The algorithm for finding classes in PHP files in Constructs has been adopted from Zend\File\ClassFileLocator (originally licensed under BSD-3-Clause).

Social

Follow @localheinz and @ergebnis on Twitter.