localheinz/classy

Provides a way to collect classy constructs from source or a directory.

classy

, _(*1)

, _(*2)

, _(*3)

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

Installation

Run, _(*5)

composer require ergebnis/classy

Usage

Collect classy constructs from source code

Use Classy\Constructs::fromSource() to collect classy constructs in source code:, _(*6)

<?php

declare(strict_types=1);

use Ergebnis\Classy;

$source = <<<'PHP'
<?php

namespace Example;

class Foo {}

enum Bar {}

interface Baz {}

trait Qux {}
PHP;

$constructs = Classy\Constructs::fromSource($source);

$names = array_map(static function (Classy\Construct $construct): string {
    return $construct->name();
}, $constructs);

var_dump($names); // ['Example\Bar', 'Example\Baz', 'Example\Foo', 'Example\Qux']

Collect classy constructs from a directory

Use Classy\Constructs::fromDirectory() to collect classy constructs in a directory:, _(*7)

<?php

declare(strict_types=1);

use Ergebnis\Classy;

$constructs = Classy\Constructs::fromDirectory(__DIR__ . '/example');

$names = array_map(static function (Classy\Construct $construct): string {
    return $construct->name();
}, $constructs);

var_dump($names); // ['Example\Bar', 'Example\Bar\Baz', 'Example\Foo\Bar\Baz']

Changelog

The maintainers of this project record notable changes to this project in a changelog., _(*8)

Contributing

The maintainers of this project suggest following the contribution guide., _(*9)

Code of Conduct

The maintainers of this project ask contributors to follow the code of conduct., _(*10)

General Support Policy

The maintainers of this project provide limited support., _(*11)

You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project., _(*12)

PHP Version Support Policy

This project supports PHP versions with active and security support., _(*13)

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., _(*14)

Security Policy

This project has a security policy., _(*15)

License

This project uses the MIT license., _(*16)

Credits

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

Social

Follow @localheinz and @ergebnis on Twitter., _(*18)