Download the PHP package api-skeletons/doctrine-orm-graphql without Composer

GraphQL Type Driver for Doctrine ORM

This library provides a GraphQL driver for Doctrine ORM for use with the webonyx/graphql-php library. It does not try to redefine how that excellent library operates. Instead, it creates types to be used within the framework that library provides.

Installation

Via composer:

Documentation

Full documentation is available at https://doctrine-orm-graphql.apiskeletons.dev or in the docs directory.

Versions

• 12.x - Supports league/event version 3.0 and is PSR-14 compliant
• 11.x - Supports league/event version 2.2

More information in the documentation.

Examples

The LDOG Stack: Laravel, Doctrine ORM, and GraphQL uses this library: https://ldog.apiskeletons.dev

For an working implementation see https://graphql.lcdb.org and the corresonding application at https://github.com/lcdborg/graphql.lcdb.org.

Features

• Supports all Doctrine Types and allows custom types
• Pagination with the GraphQL Complete Connection Model
• Filtering of sub-collections
• Events for modifying queries, entity types and more
• Multiple configuration group support

Quick Start

Add attributes to your Doctrine entities or see globalEnable for all entities in your schema without attribute configuration.

Create the driver and GraphQL schema

Run GraphQL queries

Run GraphQL mutations

Filters

For every enabled field and association, filters are available for querying.

Example

Each field has their own set of filters. Based on the field type, some or all of the following filters are available:

• eq - Equals.
• neq - Not equals.
• lt - Less than.
• lte - Less than or equal to.
• gt - Greater than.
• gte - Greater than or equal to.
• isnull - Is null. If value is true, the field must be null. If value is false, the field must not be null.
• between - Between. Identical to using gte & lte on the same field. Give values as low, high.
• in - Exists within an array.
• notin - Does not exist within an array.
• startwith - A like query with a wildcard on the right side of the value.
• endswith - A like query with a wildcard on the left side of the value.
• contains - A like query.

You may exclude any filter from any entity, association, or globally.

History

The roots of this project go back to May 2018 with https://github.com/API-Skeletons/zf-doctrine-graphql; written for Zend Framework 2. It was migrated to the framework agnostic https://packagist.org/packages/api-skeletons/doctrine-graphql but the name of that repository was incorrect because it did not specify ORM only. So this repository was created and the others were abandoned.

License

See LICENSE.