README

A PHP library for describing metadata and fake data on classes via PHP attributes, then querying them through a generic service.

Installation

composer require sylarele/object-metadata-mapper

How it works

Annotate a class with Mapper attributes to describe its structure and fake values. Implement MetadataService to resolve which class corresponds to a key (a BackedEnum). Call findByKey() to get a MetadataDto containing the descriptions and fake data.

Annotating a class

Each attribute takes a key (field name) and an optional description.

use Sylarele\ObjectMetadataMapper\Attributes\ObjectMapper;
use Sylarele\ObjectMetadataMapper\Attributes\FullNameMapper;
use Sylarele\ObjectMetadataMapper\Attributes\EmailMapper;
use Sylarele\ObjectMetadataMapper\Attributes\PhoneMapper;
use Sylarele\ObjectMetadataMapper\Attributes\ObjectEachMapper;
use Sylarele\ObjectMetadataMapper\Attributes\AddressMapper;

#[ObjectMapper(
    'user',
    new FullNameMapper('fullname'),
    new PhoneMapper('phone'),
    new EmailMapper('email'),
    new ObjectEachMapper(
        'addresses',
        2,
        new AddressMapper('address'),
    )
)]
class UserObject
{
}

Implementing MetadataService

Create a BackedEnum as a key, then extend MetadataService by implementing getClassName() to map each enum value to an annotated class.

// The key enum
enum UserType: string
{
    case Profile = 'profile';
}

use Sylarele\ObjectMetadataMapper\MetadataService;

/**
 * @extends MetadataService<UserType>
 */
class UserMetadataService extends MetadataService
{
    protected function getClassName(BackedEnum $keyTemplate): string
    {
        return match ($keyTemplate) {
            UserType::Profile => UserObject::class,
        };
    }
}

Using the service

$service = new UserMetadataService();
$dto = $service->findByKey(UserType::Profile);

// Structured fake data
$dto->fake;

// Field descriptions
$dto->description;

MetadataDto structure

Available attributes