leaditin/annotations

A simple API for reading any kind of annotations from PHP Class

1.0.2 2017-11-24 20:11 UTC

Requires

• php: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.0
• phpunit/phpunit: ^5.7 || ^6.0

MIT

• Igor Vuckovic

• annotations
• parser
• docblock
• leaditin

README

A simple API for reading any kind of annotations from PHP Class

Installation

The preferred method of installation is via Composer. Run the following command to install the latest version of a package and add it to your project's composer.json:

composer require leaditin/annotations

Usage

Instantiate your preferred storage to read doc block data of any Class in your project.

$collector = new \Leaditin\Annotations\Collector\MemoryCollector(
    new \Leaditin\Annotations\Reader\ReflectionReader()
);
$reflection = $collector->read(\Leaditin\Annotations\Reflection::class);

foreach ($reflection->getClassAnnotations() as $annotation) {
    printf('@%s %s%s',
        $annotation->getName(),
        $annotation->getArgument(0),
        PHP_EOL
    );
}

Credits

• All Contributors

License

Released under MIT License - see the License File for details.