graphpinator

Documentation

Hello!

We are happy you consider using this library.

This documentation relates to the GraPHPinator project - the PHP implementation of GraphQL server. Before you continue, make sure to understand the concepts of GraphQL and its purpose. All the necessary information is presented on the official website.

Version 2.0 Breaking Changes

Version 2.0 introduces several important changes. Please review these if you are upgrading from an earlier version:

Requirements

• Minimum PHP version is now 8.2 (previously 8.1)

Scalar Type Coercion

• Custom scalar types must implement new methods:
  • validateAndCoerceInput(mixed $rawValue) : mixed - replaces the old validateNonNullValue method for input validation
  • coerceOutput(mixed $rawValue) : string|int|float|bool - new method for output coercion
• The old validateNonNullValue method has been removed

Enhanced Schema Validation

• Schema validation now checks resolver function return types against field type definitions
• NotNull fields require non-nullable return types
• List fields require iterable return types

Namespace Changes

Some classes have been moved to different namespaces. Please check your imports if you encounter class-not-found errors after upgrading.

For detailed migration instructions, see the Migration Guide.

Compliance status

This library aims at the latest draft of the GraphQL specification. The current version supports all the features and is ready to be used in real-world applications.

Known incompatibilities can be found in issues with “Spec incompatibility” label. Those deviations from specification should not affect your application in any way, but are listed anyway for full transparency.

Table of contents:

Starting out

This section includes some general information about the library and how to use it but does not go deep into unnecessary detail.

If you prefer to read less text and more code - check out the Examples

• Schema definition and typesystem
  • Creating types (Type, Interface, Union, Scalar, Enum, Input)
  • Schema validation and integrity checks
  • Field resolver validation
  • Performance best practices
  • Error handling
  • Advanced type system features
• Request execution

Addons

Information about unofficial extensions this library provides.

• Addon types
• Constraint directives
• Modules
  • Upload
  • Query cost
  • Persisted queries

Utilities

Information about internal components, which may be used as standalone tools.

• How does this lib work internally
• Tokenizer
• Parser

Examples:

1. Hello World
2. Union
3. Interface
4. Enum
5. Arguments
6. Input
7. Deprecated
8. Constraints
9. Addon types
10. Upload

This site is open source. Improve this page.