Wallogit.com
2017 © Pedro Peláez
A GraphQL Doctrine ORM bridge
, (*1)
Generates all the necessary types, queries and mutators using the Doctrine model metadata. All standard data fetching uses the doctrine Array Hydrator. This provider will handle the Object hydration once all queries are finished and the data is ready to be returned., (*2)
The provider can be setup to filter what objects and properties are included in the final graphql api. * Whitelisting will only include types/properties that are marked for inclusion * Blacklisting will only include types/properties that are not marked for exclusion, (*3)
An authorization provider can be implemented to limit access to types and fields via cred level permissions, (*4)
Names and descriptions of types and methods can be overwritten via the GraphQLType and GraphQLProperty annotations. Field Names are not yet able to be overwritten., (*5)
Associations take advantage of deferred loading via the DeferredBuffer. This is used to significantly reduce the number of queries and solves the N+1 problem when loading data (https://secure.phabricator.com/book/phabcontrib/article/n_plus_one/), (*6)
Any property can have it's own custom resolver instead of the standard one provided by the provider., (*7)
The provider supports key and offset pagination for top level queries. Also supports limiting results returned in an n-to-Many relationship., (*8)
A queries results can be sorted by one or more fields in either ascending or descending order., (*9)
Core types such as Strings, DateTime, Int, and BigInt support filters such as, (*10)
equals, in, less, greater, lessOrEqual, greaterOrEqual, between, (*11)
Provider supports querying polymorphic entities and querying unique fields per type using the GraphQL inline fragments., (*12)
After initializing doctrine you'll need to register the graphql annotations:, (*13)
```php use RateHub\GraphQL\Doctrine\AnnotationLoader; use Doctrine\Common\Annotations\AnnotationRegistry;, (*14)
AnnotationRegistry::registerLoader(array(new AnnotationLoader(), "load")); ```, (*15)
The next step is to initialize the graphql schema:, (*16)
```php use RateHub\GraphQL\Doctrine\DoctrineProvider; use RateHub\GraphQL\Doctrine\DoctrineProviderOptions; use RateHub\GraphQL\GraphContext; use GraphQL\Type\Definition\ObjectType; use GraphQL\Schema;, (*17)
// Set the options including any extensions $options = new DoctrineProviderOptions(); $options->em = $em; // EntityManager initialized within your as app as needed $options->filter = 'blacklist', (*18)
// Initialize the Provider. With blacklist filtering, no // annotations are needed unless something needs to be // excluded. The provider will generate all queries, // mutators and types needed. $provider = new DoctrineProvider('default', $options);, (*19)
// Initialize top level types $context = new GraphContext(); $queryType = new ObjectType('query', $provider->getQueries()); $mutatorType = new ObjectType('mutator', $provider->getMutators());, (*20)
// Initialize the schema $schema = new Schema([ 'query' => $queryType, 'mutation' => $mutatorType, 'types' => $provider->getTypes() ]);, (*21)
```, (*22)
From here you can execute a query:, (*23)
php
$result = \GraphQL\GraphQL::execute(
$schema,
$params['query'], // Request parameter containing the graphql query
null,
$context,
null
);, (*24)
A GraphQL Doctrine ORM bridge
MIT
orm database doctrine data mapper graphql
A GraphQL Doctrine ORM bridge
MIT
orm database doctrine data mapper graphql