alks/metadata

Provides metadata generation for PHP classes

v1.1.1 2022-09-26 10:18 UTC

Requires

• php: ^7.4
• doctrine/annotations: ^1.6
• psr/simple-cache: ^1.0

Requires (Dev)

• mikey179/vfsstream: ^1.6
• phpunit/phpunit: ^8.5.2

MIT

• Alkis Stamos

• metadata

README

Provides metadata for PHP classes and their members using a collection of metadata drivers

Installation

composer require alks/metadata

Usage

The library comes with 3 metadata driver implementations.

• The Reflection Metadata driver collects data using the PHP Reflection API
• The Doc Comment Metadata driver parses PHPDoc doc blocks
• The Annotation Metadata driver parses Doctrine Annotations

Basically each driver extends the one(s) above him (the doc comment driver will use the reflection api as well). In order to use the library generate an instance of the default MetadataDriver and register which drivers (and caches) to use:

<?php
require_once 'vendor/autoload.php';
$driver = new \Alks\Metadata\MetadataDriver();
$driver->register(new \Alks\Metadata\Driver\DocCommentDriver());

If you want to get the full use out of the library just call the enableAnnotations method. This will register the Annoation metadata driver which makes use of all the installed drivers behaviour (remember to register the autoloader in the driver registry):

<?php
require_once 'vendor/autoload.php';
$driver = new \Alks\Metadata\MetadataDriver();
$driver->enableAnnotations(__DIR__.'/var');//extra parameter to cache the doctrine annotation separately

Anyway, once you have the driver in place get the metadata like this:

<?php
class ThisIsTheTargetClass {}
// Composer and stuff..
$driver = new \Alks\Metadata\MetadataDriver();
// Register (or enable) all drivers..
/** @var \Alks\Metadata\Metadata\ClassMetadata $metadata */
$metadata = $driver->getClassMetadata(new ReflectionClass(ThisIsTheTargetClass::class));