Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/API-Skeletons/doctrine-graphql
GraphQL Type Driver for Doctrine ORM
https://github.com/API-Skeletons/doctrine-graphql
doctrine graphql
Last synced: 7 days ago
JSON representation
GraphQL Type Driver for Doctrine ORM
- Host: GitHub
- URL: https://github.com/API-Skeletons/doctrine-graphql
- Owner: API-Skeletons
- License: mit
- Created: 2020-07-06T04:36:09.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T21:31:20.000Z (2 months ago)
- Last Synced: 2024-10-02T08:37:46.215Z (about 1 month ago)
- Topics: doctrine, graphql
- Language: PHP
- Homepage:
- Size: 1.19 MB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
GraphQL Type Driver for Doctrine ORM
====================================
This project has been retired in favor of [API-Skeletons/doctrine-orm-graphql](https://github.com/API-Skeletons/doctrine-orm-graphql)
===================================
See the [upgrade guide](https://doctrine-orm-graphql.apiskeletons.dev/en/latest/upgrade.html) if you're a user of the 8.x branch.
All the original documentation can be found below.
[](https://github.com/API-Skeletons/doctrine-graphql/actions/workflows/continuous-integration.yml?query=branch%3Amain)
[](https://codecov.io/gh/API-Skeletons/doctrine-graphql/branch/main)
[](https://scrutinizer-ci.com/g/API-Skeletons/doctrine-graphql/?branch=main)
[](https://img.shields.io/badge/PHP-8.0%2b-blue)
[](//packagist.org/packages/api-skeletons/doctrine-graphql)
[](//packagist.org/packages/api-skeletons/doctrine-graphql)
This library provides a framework agnostic GraphQL driver for Doctrine ORM for use with [webonyx/graphql-php](https://github.com/webonyx/graphql-php). Configuration is available from zero to verbose. Multiple configurations for multiple drivers are supported.
[Detailed documentation](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/) is available.
For an example application post to `https://graphql.lcdb.org/`
Library Highlights
------------------
* Uses [PHP 8 Attributes](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/attributes.html)
* [Multiple independent configurations](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/config.html)
* Support for all default [Doctrine Types](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html) & custom types
* Support for the [GraphQL Complete Connection Model](https://graphql.org/learn/pagination/#complete-connection-model)
* Supports [filtering of sub-collections](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/queries.html)
* [Events](https://github.com/API-Skeletons/doctrine-graphql#events) for modifying queries and entity types
* Uses the [Doctrine Laminas Hydrator](https://www.doctrine-project.org/projects/doctrine-laminas-hydrator/en/3.1/index.html) for extraction
* Conforms to the [Doctrine Coding Standard](https://www.doctrine-project.org/projects/doctrine-coding-standard/en/9.0/index.html)
Installation
------------
Run the following to install this library using [Composer](https://getcomposer.org/):
```bash
composer require api-skeletons/doctrine-graphql
```
Entity Relationship Diagram
---------------------------
[This Entity Relationship Diagram](https://raw.githubusercontent.com/API-Skeletons/doctrine-graphql/master/test/doctrine-graphql.skipper), created with [Skipper](https://skipper18.com), is used for the query examples below and testing this library.
Quick Start
-----------
Add attributes to your Doctrine entities
```php
use ApiSkeletons\Doctrine\GraphQL\Attribute as GraphQL;
#[GraphQL\Entity]
class Artist
{
#[GraphQL\Field]
public $id;
#[GraphQL\Field]
public $name;
#[GraphQL\Association]
public $performances;
}
#[GraphQL\Entity]
class Performance
{
#[GraphQL\Field]
public $id;
#[GraphQL\Field]
public $venue;
/**
* Not all fields need attributes.
* Only add attribues to fields you want available in GraphQL
*/
public $city;
}
```
Create the driver and GraphQL schema
```php
use ApiSkeletons\Doctrine\GraphQL\Driver;
use Doctrine\ORM\EntityManager;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Type\Schema;
$driver = new Driver($entityManager);
$schema = new Schema([
'query' => new ObjectType([
'name' => 'query',
'fields' => [
'artists' => [
'type' => $driver->connection($driver->type(Artist::class)),
'args' => [
'filter' => $driver->filter(Artist::class),
'pagination' => $driver->pagination(),
],
'resolve' => $driver->resolve(Artist::class),
],
],
]),
'mutation' => new ObjectType([
'name' => 'mutation',
'fields' => [
'artistUpdateName' => [
'type' => $driver->type(Artist::class),
'args' => [
'id' => Type::nonNull(Type::id()),
'input' => Type::nonNull($driver->input(Artist::class, ['name'])),
],
'resolve' => function ($root, $args) use ($driver): Artist {
$artist = $driver->get(EntityManager::class)
->getRepository(Artist::class)
->find($args['id']);
$artist->setName($args['input']['name']);
$driver->get(EntityManager::class)->flush();
return $artist;
},
],
],
]),
]);
```
Run GraphQL queries
```php
use GraphQL\GraphQL;
$query = '{
artists {
edges {
node {
id
name
performances {
edges {
node {
venue
}
}
}
}
}
}
}';
$result = GraphQL::executeQuery(
schema: $schema,
source: $query,
variableValues: null,
operationName: null
);
$output = $result->toArray();
```
Run GraphQL mutations
```php
use GraphQL\GraphQL;
$query = 'mutation ArtistUpdateName($id: Int!, $name: String!) {
artistUpdateName(id: $id, input: { name: $name }) {
id
name
}
}';
$result = GraphQL::executeQuery(
schema: $schema,
source: $query,
variableValues: ['id' => 1, 'name' => 'newName'],
operationName: 'ArtistUpdateName'
);
$output = $result->toArray();
```
Filtering
---------
For every attributed field and every attributed association, filters are available in your
GraphQL query.
Example
```gql
{
artists ( filter: { name: { contains: "dead" } } ) {
edges {
node {
id
name
performances ( filter: { venue: { eq: "The Fillmore" } } ) {
edges {
node {
venue
}
}
}
}
}
}
}
```
Each field has their own set of filters. Most fields have the following:
* eq - Equals.
* neq - Not equals.
* lt - Less than.
* lte - Less than or equal to.
* gt - Greater than.
* gte - Greater than or equal to.
* isnull - Is null. If value is true, the field must be null. If value is false, the field must not be null.
* between - Between. Identical to using gte & lte on the same field. Give values as `low, high`.
* in - Exists within a list of comma-delimited values.
* notin - Does not exist within a list of comma-delimited values.
* startwith - A like query with a wildcard on the right side of the value.
* endswith - A like query with a wildcard on the left side of the value.
* contains - A like query.
Events
------
### Filter Query Builder
You may modify the query builder used to resolve any connection by subscribing to events.
Each connection may have a unique event name. `Entity::class . '.filterQueryBuilder'` is recommended.
Pass as the second parameter to `$driver->resolve()`.
```php
use ApiSkeletons\Doctrine\GraphQL\Event\FilterQueryBuilder;
use App\ORM\Entity\Artist;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Schema;
use League\Event\EventDispatcher;
$schema = new Schema([
'query' => new ObjectType([
'name' => 'query',
'fields' => [
'artists' => [
'type' => $driver->connection($driver->type(Artist::class)),
'args' => [
'filter' => $driver->filter(Artist::class),
'pagination' => $driver->pagination(),
],
'resolve' => $driver->resolve(Artist::class, Artist::class . '.filterQueryBuilder'),
],
],
]),
]);
$driver->get(EventDispatcher::class)->subscribeTo(Artist::class . '.filterQueryBuilder',
function(FilterQueryBuilder $event) {
$event->getQueryBuilder()
->innerJoin('entity.user', 'user')
->andWhere($event->getQueryBuilder()->expr()->eq('user.id', ':userId'))
->setParameter('userId', currentUser()->getId())
;
}
);
```
### Filter Association Criteria
You may modify the criteria object used to filter associations. For instance, if you use soft
deletes then you would want to filter out deleted rows from an association.
```php
use ApiSkeletons\Doctrine\GraphQL\Attribute as GraphQL;
use ApiSkeletons\Doctrine\GraphQL\Event\FilterCriteria;
use App\ORM\Entity\Artist;
use League\Event\EventDispatcher;
#[GraphQL\Entity]
class Artist
{
#[GraphQL\Field]
public $id;
#[GraphQL\Field]
public $name;
#[GraphQL\Association(filterCriteriaEventName: self::class . '.performances.filterCriteria')]
public $performances;
}
// Add a listener to your driver
$driver->get(EventDispatcher::class)->subscribeTo(
Artist::class . '.performances.filterCriteria',
function (FilterCriteria $event): void {
$event->getCriteria()->andWhere(
$event->getCriteria()->expr()->eq('isDeleted', false)
);
},
);
```
### Entity ObjectType Definition
You may modify the array used to define an entity type before it is created. This can be used for generated data and the like.
You must attach to events before defining your GraphQL schema. See the [detailed documentation](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/events.html#modify-an-entity-definition) for details.
```php
use ApiSkeletons\Doctrine\GraphQL\Driver;
use ApiSkeletons\Doctrine\GraphQL\Event\EntityDefinition;
use App\ORM\Entity\Artist;
use GraphQL\Type\Definition\ResolveInfo;
use GraphQL\Type\Definition\Type;
use League\Event\EventDispatcher;
$driver = new Driver($entityManager);
$driver->get(EventDispatcher::class)->subscribeTo(
Artist::class . '.definition',
static function (EntityDefinition $event): void {
$definition = $event->getDefinition();
// In order to modify the fields you must resovle the closure
$fields = $definition['fields']();
// Add a custom field to show the name without a prefix of 'The'
$fields['nameUnprefix'] = [
'type' => Type::string(),
'description' => 'A computed dynamically added field',
'resolve' => static function ($objectValue, array $args, $context, ResolveInfo $info): mixed {
return trim(str_replace('The', '', $objectValue->getName()));
},
];
$definition['fields'] = $fields;
}
);
```
Further Reading
---------------
[Detailed documentation](https://apiskeletons-doctrine-graphql.readthedocs.io/en/latest/)
is available.