Schema Definition
Schema is a container of your type hierarchy, which accepts root types in constructor and provides methods for receiving information about your types to internal GrahpQL tools.
In graphql-php schema is an instance of GraphQL\Schema
which accepts configuration array
in constructor:
$schema = new Schema([
'query' => $queryType,
'mutation' => $mutationType,
]);
See possible constructor options below
Query and Mutation types
Schema consists of two root types:
Query
type is a surface of your read APIMutation
type (optional) exposes write API by declaring all possible mutations in your app.
Query and Mutation types are regular object types containing root-level fields of your API:
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;
use GraphQL\Schema;
$queryType = new ObjectType([
'name' => 'Query',
'fields' => [
'hello' => [
'type' => Type::string(),
'resolve' => function() {
return 'Hello World!';
}
]
'hero' => [
'type' => $characterInterface,
'args' => [
'episode' => [
'type' => $episodeEnum
]
],
'resolve' => function ($rootValue, $args) {
return StarWarsData::getHero(isset($args['episode']) ? $args['episode'] : null);
},
]
]
]);
$mutationType = new ObjectType([
'name' => 'Mutation',
'fields' => [
'createReviewForEpisode' => [
'type' => $createReviewForEpisodeMutation,
'args' => [
'episode' => $episodeEnum,
'review' => $reviewInputObject
],
'resolve' => function($val, $args) {
// TODOC
}
]
]
]);
Keep in mind that other than the special meaning of declaring surface area of your API, those types are the same as any other object type, and their fields work exactly the same way.
Mutation type is also just a regular object type. The difference is in semantics. Field names of Mutation type are usually verbs and they almost always have arguments - quite often with complex input values (see Input Types for details).
Configuration Options
Schema constructor expects an array with following options:
Option | Type | Notes |
---|---|---|
query | ObjectType |
Required. Object type (usually named "Query") containing root-level fields of your read API |
mutation | ObjectType |
Object type (usually named "Mutation") containing root-level fields of your write API |
subscription | ObjectType |
Reserved for future subscriptions implementation. Currently presented for compatibility with introspection query of graphql-js, used by various clients (like Relay or GraphiQL) |
directives | Directive[] |
Full list of directives supported by your schema. By default contains built-in @skip and @include directives.If you pass your own directives and still want to use built-in directives - add them explicitly. For example: array_merge(GraphQL::getInternalDirectives(), [$myCustomDirective] |
types | ObjectType[] |
List of object types which cannot be detected by graphql-php during static schema analysis. Most often it happens when object type is never referenced in fields directly, but is still a part of schema because it implements an interface which resolves to this object type in it's resolveType callback. Note that you are not required to pass all of your types here - it is simply a workaround for concrete use-case. |