Input.md

Input

This example serves as a simple tutorial on how to create a simple input and use it as an argument type.

Introduction

In this example, we define a simple schema with one input and execute one request on it. You should be familiar with our previous HelloWorld example to understand the basics.

Define our types

Here we define one Query object type and one Person input.

<?php

declare(strict_types = 1);

namespace Example;

final class Query extends \Graphpinator\Typesystem\Type
{
    protected const NAME = 'Query';
    protected const DESCRIPTION = 'Graphpinator Input: Query type';

    private \Example\Person $person;

    public function __construct(\Example\Person $person) 
    {
        parent::__construct();
    
        $this->person = $person;
    }

    public function validateNonNullValue($rawValue) : bool
    {
        return true;
    }

    protected function getFieldDefinition() : \Graphpinator\Typesystem\Field\ResolvableFieldSet
    {
        return new \Graphpinator\Typesystem\Field\ResolvableFieldSet([
            \Graphpinator\Typesystem\Field\ResolvableField::create(
                'print',
                \Graphpinator\Typesystem\Container::String()->notNull(),
                function ($parent, \stdClass $arg) : string {
                    return 'User ' . $arg->name . ', age: ' . $arg->age;
                },
            )->setArguments(
                new \Graphpinator\Typesystem\Argument\ArgumentSet([
                    \Graphpinator\Typesystem\Argument\Argument::create(
                        'arg',
                        $this->person->notNull(),
                    ),            
                ])
            ),
        ]);
    }
}

final class Person extends \Graphpinator\Typesystem\InputType
{
    protected const NAME = 'Person';
    protected const DESCRIPTION = 'Graphpinator Input: Person input';

    protected function getFieldDefinition() : \Graphpinator\Typesystem\Argument\ArgumentSet
    {
        return new \Graphpinator\Typesystem\Argument\ArgumentSet([
            \Graphpinator\Typesystem\Argument\Argument::create(
                'name',
                \Graphpinator\Typesystem\Container::String()->notNull(),
            ),
            \Graphpinator\Typesystem\Argument\Argument::create(
                'age',
                \Graphpinator\Typesystem\Container::Int()->notNull(),
            ),
        ]);
    }
}

As you can see, declaring an input is really simple - just implement the getFieldDefinition() method and return its input fields.

Optional step - print schema definition

Visualize our GraphQL schema in type language.

Declaration of Container, Schema and Graphpinator classes is skipped in this example. Visit our HelloWorld example for more information.

Printing the schema using infinityloop-dev/graphpinator-printer produces following schema.

schema {
  query: Query
  mutation: null
  subscription: null
}

"""
Graphpinator Input: Person input
"""
input Person {
  name: String!
  age: Int!
}

"""
Graphpinator Input: Query type
"""
type Query {
  print(arg: Person!): String!
}

Execute Request

$json = \Infinityloop\Utils\Json::fromString(
    '{"query":"query { print(arg: {name: "peldax", age: 26}) }"}'
);
$requestFactory = new \Graphpinator\Request\JsonRequestFactory($json);
$response = $graphpinator->run($requestFactory);

This is it, we have our response in $response variable. The query above will produce:

{"data":{"print": "User peldax, age 26"}}

Congratulations

This is the end of the Input example, thank you for reading this far.

• For more information visit the complete Docs.
• For more examples visit the examples folder.