entity-mapping.md

Entity mapping

Define an entity

use GraphqlOrm\Attribute\GraphqlEntity;
use GraphqlOrm\Attribute\GraphqlField;

#[GraphqlEntity(name: 'tasks', repositoryClass: TaskRepository::class)]
class Task
{
    #[GraphqlField(mappedFrom: 'id', identifier: true)]
    public int $id;

    #[GraphqlField(mappedFrom: 'title')]
    public string $title;

    #[GraphqlField(mappedFrom: 'dueDate')]
    public ?DateTimeImmutable $dueDate = null;

    #[GraphqlField(mappedFrom: 'user')]
    public ?User $user = null;
}

#[GraphqlEntity]

Parameter	Type	Description
name	string	GraphQL root query field name (e.g. tasks)
repositoryClass	class-string|null	Associated repository class

#[GraphqlField]

Parameter	Type	Description
mappedFrom	string	Field name in the GraphQL schema
identifier	bool	Marks this field as the entity identifier
targetEntity	class-string|null	Explicit relation target (optional if PHP type is set)
ignoreValidation	bool	Ignore the schema validation

Relations

Relations are detected automatically from the PHP property type:

// Automatic detection via PHP type
#[GraphqlField(mappedFrom: 'user')]
public User $user;

// Explicit declaration
#[GraphqlField(mappedFrom: 'user', targetEntity: User::class)]
public mixed $user;

// Collection
#[GraphqlField(mappedFrom: 'tasks')]
public array $tasks = [];

Supported PHP types

PHP type	GraphQL scalars
int	Int, ID
float	Float
string	String, ID, Date, DateTime, Time, JSON, UUID
bool	Boolean
DateTimeImmutable	DateTime, Date, Time, String

DateTimeImmutable fields are automatically cast from ISO 8601 strings or Unix timestamps (in milliseconds).