A simple yet powerful GraphQL query builder
Writing GraphQL queries can be a painful process. With GraphpQL query builder write PHP and get GraphQL
When finding an Hero to be his sidekick one finds himself overwhelmed with the number of Heros out there. There are all sort of Heros so lets list them all
$hero = new GraphQL\Graph('hero');
echo $hero->use('name')
->friends
->use('name')
->root()
->query();will generate
{
hero {
name
friends {
name
}
}
}
A Hero will have many friends which can make it hard to walk through, it would be great limit the Hero's friends to 2
$hero = new GraphQL\Graph('hero');
echo $hero->use('name')
->friends(['first'=>2])
->use('name')
->root()
->query();will generate
{
hero {
name
friends(first: 2) {
name
}
}
}
Sometimes you might need to know more about this Hero, like when you want to know a hero friends and costumes. We then need to go back in the Hero tree. For that we'll use $node->prev()
$hero = new GraphQL\Graph('hero');
echo $hero->use('name')
->friends(['first'=>2])
->use('name')
->prev()
->costumes
->color
->root()
->query();will generate
{
hero {
name
friends(first: 2) {
name
}
costumes {
color
}
}
}
Sometimes you don't quite know the type of hero you looking for. Maybe you looking a flying Hero, maybe a Strong Hero
$hero = new GraphQL\Graph('hero');
echo $hero->use('name')
->on('FlyingHero')
->use('hasCape')
->prev()
->on('StrongHero')
->use('strengthLevel')
->prev()
->friends(['first'=>2])
->use('name')
->prev()
->costumes
->color
->root()
->query();Will generate
{
hero {
name
... on FlyingHero {
hasCape
}
... on StrongHero {
strengthLevel
}
friends(first: 2) {
name
}
costumes {
color
}
}
}
For the element of surprise, you might need to name some of the hero's properties differently; You might want to call friends as partners_in_good or name as call_me_this
$hero = new GraphQL\Graph('hero');
echo $hero->use('name')
->alias('call_me_this', 'name')
->friends(['first'=>2])
->alias('partners_in_good')
->use('name')
->prev()
->costumes
->color
->root()
->query();will generate
{
hero {
call_me_this: name
partners_in_good: friends(first: 2) {
name
}
costumes {
color
}
}
}
Sorry have no super hero narrative from here :D . sticking to good old technical explanation
To use fragments declare the fragment as you would a graph and then use it within a ->use() call as you would with a regular property
$fragment = new GraphQL\Fragment('properties', 'Hero');
$fragment->use('id', 'age');
$hero = new GraphQL\Graph('hero');
echo $hero->use('name', $fragment)->query();
echo $fragment->query();will generate
{
hero {
name
...properties
}
}
fragment properties on Hero {
id
age
}
The use of variables feels less necessary because we're using PHP to build the query. Still...
$variable = new GraphQL\Variable('name', 'String');
$hero = new GraphQL\Graph('hero', ['name' => $variable]);
echo $hero->use('name')->query();will generate
query getGraph($name: String){
hero(name: $name) {
name
}
}
you can also use meta fields the same way you would request a property
$variable = new GraphQL\Variable('name', 'String');
$hero = new GraphQL\Graph('hero', ['name' => $variable]);
echo $hero->use('name', '__typename')->query();will generate
query getGraph($name: String){
hero(name: $name) {
name
__typename
}
}
Which can also be aliased
$variable = new GraphQL\Variable('name', 'String');
$hero = new GraphQL\Graph('hero', ['name' => $variable]);
echo $hero->use('name', '__typename')
->alias('type', '__typename')
->query();will generate
query getGraph($name: String){
hero(name: $name) {
name
type: __typename
}
}
After you chose your Hero and he takes you as his sidekick he will let you do some help him with some of his daily routine. He might even let you choose his costume color. How cool is that?
$mutation = new GraphQL\Mutation('changeHeroCostumeColor', ['id' => 'theHeroId', 'color'=>'red']);
$mutation
->hero
->use('name')
->costumes
->use('color')
->root()
->query();Will generate
mutation changeHeroCostumeColor(id: 'theHeroId', color: 'red') {
hero {
name
costumes {
color
}
}
}
With variables
$mutation = new GraphQL\Mutation('changeHeroCostumeColor', ['id' => new GraphQL\Variable('uuid', 'String', ''), new GraphQL\Variable('color', 'String', '')]);
$mutation
->hero
->use('name')
->costumes
->use('color')
->root()
->query();Will generate
mutation ChangeHeroCostumeColorMutation($uuid: String, $color: String) {
changeHeroCostumeColorAction(id: $uuid, color: $color) {
hero {
name
costumes {
color
}
}
}
}
Hey dude! Help me out for a couple of 🍻!
