Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/4rthem/graphql-mapper
ABANDONED - A PHP library to build GraphQL schema based on your model.
https://github.com/4rthem/graphql-mapper
graphql mapping model
Last synced: about 1 month ago
JSON representation
ABANDONED - A PHP library to build GraphQL schema based on your model.
- Host: GitHub
- URL: https://github.com/4rthem/graphql-mapper
- Owner: 4rthem
- License: mit
- Created: 2015-11-03T23:14:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-16T07:55:40.000Z (over 7 years ago)
- Last Synced: 2024-10-31T17:39:23.291Z (about 1 month ago)
- Topics: graphql, mapping, model
- Language: PHP
- Homepage:
- Size: 54.7 KB
- Stars: 31
- Watchers: 5
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-graphql - graphql-mapper - This library allows to build a GraphQL schema based on your model. (Libraries / PHP Libraries)
- awesome-graphql - graphql-mapper - This library allows to build a GraphQL schema based on your model. (Libraries / PHP Libraries)
README
# [ABANDONED] GraphQL Mapper
[](https://travis-ci.org/4rthem/graphql-mapper)
[](https://insight.sensiolabs.com/projects/18bf298d-a139-4185-afdb-9226dfd2dc8c)
[](https://scrutinizer-ci.com/g/4rthem/graphql-mapper/?branch=master)
This library allows to build a GraphQL schema based on your model.
It depends on the [GraphQL PHP implementation](https://github.com/webonyx/graphql-php)
See [graphql-mapper-demo](https://github.com/4rthem/graphql-mapper-demo) for a full working example!
## Installation
This is installable via [Composer](https://getcomposer.org/) as [arthem/graphql-mapper](https://packagist.org/packages/arthem/graphql-mapper):
```bash
composer require arthem/graphql-mapper
```
## Setup / Configuration
Create your schema:
```yaml
# /path/to/your/mapping/file.yml
interfaces:
Character:
resolve:
handler: doctrine
model: AppBundle\Entity\Character
description: A character in the Star Wars Trilogy
fields:
id:
type: Int!
description: The id of the character.
name:
type: String!
description: The name of the character.
friends:
type: "[Character]"
description: The friends of the character, or an empty list if they have none.
appearsIn:
type: "[Episode]"
description: Which movies they appear in.
types:
Episode:
description: One of the films in the Star Wars Trilogy
values:
NEWHOPE:
value: 4
description: Released in 1977.
EMPIRE:
value: 5
description: Released in 1980.
JEDI:
value: 6
description: Released in 1983.
Human:
resolve:
handler: doctrine
model: AppBundle\Entity\Human
description: A humanoid creature in the Star Wars universe.
interfaces: Character
fields:
id:
description: The id of the human.
name:
description: The name of the human.
friends:
type: "[Character]"
description: The friends of the human, or an empty list if they have none.
appearsIn:
type: "[Episode]"
description: Which movies they appear in.
homePlanet:
description: The home planet of the human, or null if unknown.
Droid:
resolve:
handler: doctrine
model: AppBundle\Entity\Droid
description: A mechanical creature in the Star Wars universe.
interfaces: Character
fields:
id:
description: The id of the droid.
name:
description: The name of the droid.
friends:
type: "[Character]"
description: The friends of the droid, or an empty list if they have none.
appearsIn:
type: "[Episode]"
description: Which movies they appear in.
primaryFunction:
description: The primary function of the droid.
query:
fields:
hero:
resolve:
method: getHero
type: Character
args:
episode:
description: If omitted, returns the hero of the whole saga. If provided, returns the hero of that particular episode.
type: Episode
human:
type: Human
args:
id:
description: id of the human
type: String!
droid:
type: Droid
args:
id:
description: id of the droid
type: String!
date:
type: "[String]"
description: The current time
resolve:
function: getdate
no_args: true
mutation:
fields:
createDroid:
type: Droid
resolve:
method: createDroid
args:
id:
type: Int!
description: The id of the droid.
name:
type: String!
description: The name of the droid.
primaryFunction:
type: String
description: The primary function of the droid.
appearsIn:
type: "[Episode]"
description: Which movies they appear in.
```
> NB: listOf types must be wrapped by quotes `type: "[User]"`
## Usage
```php
// entry.php
use Arthem\GraphQLMapper\GraphQLManager;
use Arthem\GraphQLMapper\SchemaSetup;
use Arthem\GraphQLMapper\Exception\QueryException;
// bootstrap.php
require_once '../vendor/autoload.php';
// replace with mechanism to retrieve Doctrine EntityManager in your app
$entityManager = getEntityManager();
// GraphQL part
$paths = ['/path/to/your/mapping/file.yml'];
$schemaFactory = SchemaSetup::createDoctrineYamlSchemaFactory($paths, $entityManager);
$graphQLManager = new GraphQLManager($schemaFactory);
try {
$data = $graphQLManager->query($_POST['query']);
echo json_encode($data);
} catch (QueryException $e) {
echo json_encode($e);
}
```
Ready to query:
```bash
curl -XPOST 'http://localhost/entry.php' -d 'query=query FooBar {
luke: hero(episode: EMPIRE) {
id,
name,
friends {
id, name
}
},
droid(id: "2001") {
primaryFunction
}
}'
```
## Custom Resolver
Resolvers are responsible for creating function (Closure) to resolve the data.
The way to use a specific factory is to define the `handler` key in the `resolve` node.
Internal handlers are: `property`, `callable` and `doctrine`.
But you can define your own!
Create your `CustomResolver` that implements `Arthem\GraphQLMapper\Schema\Resolve\ResolverInterface`
Then register it to the `SchemaFactory`:
```php
$schemaFactory = SchemaSetup::createDoctrineYamlSchemaFactory($paths, $entityManager);
$schemaFactory->addResolver(new CustomResolver());
```
## Custom Guesser
TODOC
## License
Released under the [MIT License](LICENSE).