PHPackages                             ivome/graphql-relay-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. ivome/graphql-relay-php

ActiveLibrary[API Development](/categories/api)

ivome/graphql-relay-php
=======================

A PHP port of GraphQL Relay reference implementation

v0.7.0(2y ago)271632.4k↓35.8%28[1 issues](https://github.com/ivome/graphql-relay-php/issues)[1 PRs](https://github.com/ivome/graphql-relay-php/pulls)5BSD-3-ClausePHPPHP ^7.1 || ^8.0

Since Feb 29Pushed 2y ago14 watchersCompare

[ Source](https://github.com/ivome/graphql-relay-php)[ Packagist](https://packagist.org/packages/ivome/graphql-relay-php)[ Docs](https://github.com/ivome/graphql-relay-php)[ RSS](/packages/ivome-graphql-relay-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (3)Versions (14)Used By (5)

Relay Library for graphql-php
=============================

[](#relay-library-for-graphql-php)

This is a library to allow the easy creation of Relay-compliant servers using the [graphql-php](https://github.com/webonyx/graphql-php) reference implementation of a GraphQL server.

[![Build Status](https://camo.githubusercontent.com/0b3504635626e844f24ae1a90965a4e6842f7744f3a3169cf87eab86665f219e/68747470733a2f2f7472617669732d63692e6f72672f69766f6d652f6772617068716c2d72656c61792d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/ivome/graphql-relay-php)[![Coverage Status](https://camo.githubusercontent.com/9f1832d54528389163f5da5525341c5767a10d462f9b71aeca7a194970c8ae95/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f69766f6d652f6772617068716c2d72656c61792d7068702f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/ivome/graphql-relay-php?branch=master)

*Note: The code is a port of the original [graphql-relay js implementation](https://github.com/graphql/graphql-relay-js)from Facebook* (With some minor PHP related adjustments and extensions)

Current Status:
---------------

[](#current-status)

The basic functionality with the helper functions is in place along with the tests. Only the asynchronous functionality was not yet ported due to the limitations of PHP. See also discussions [here](https://github.com/ivome/graphql-relay-php/issues/1) and [here](https://github.com/webonyx/graphql-php/issues/42)

Getting Started
---------------

[](#getting-started)

A basic understanding of GraphQL and of the graphql-php implementation is needed to provide context for this library.

An overview of GraphQL in general is available in the [README](https://github.com/facebook/graphql/blob/master/README.md) for the [Specification for GraphQL](https://github.com/facebook/graphql).

This library is designed to work with the [graphql-php](https://github.com/webonyx/graphql-php) reference implementation of a GraphQL server.

An overview of the functionality that a Relay-compliant GraphQL server should provide is in the [GraphQL Relay Specification](https://facebook.github.io/relay/docs/graphql-relay-specification.html)on the [Relay website](https://facebook.github.io/relay/). That overview describes a simple set of examples that exist as [tests](tests) in this repository. A good way to get started with this repository is to walk through that documentation and the corresponding tests in this library together.

Using Relay Library for graphql-php
-----------------------------------

[](#using-relay-library-for-graphql-php)

Install this repository via composer:

```
composer require ivome/graphql-relay-php
```

When building a schema for [graphql-php](https://github.com/webonyx/graphql-php), the provided library functions can be used to simplify the creation of Relay patterns.

### Connections

[](#connections)

Helper functions are provided for both building the GraphQL types for connections and for implementing the `resolve` method for fields returning those types.

- `Relay::connectionArgs` returns the arguments that fields should provide when they return a connection type that supports bidirectional pagination.
- `Relay::forwardConnectionArgs` returns the arguments that fields should provide when they return a connection type that only supports forward pagination.
- `Relay::backwardConnectionArgs` returns the arguments that fields should provide when they return a connection type that only supports backward pagination.
- `Relay::connectionDefinitions` returns a `connectionType` and its associated `edgeType`, given a node type.
- `Relay::edgeType` returns a new `edgeType`
- `Relay::connectionType` returns a new `connectionType`
- `Relay::connectionFromArray` is a helper method that takes an array and the arguments from `connectionArgs`, does pagination and filtering, and returns an object in the shape expected by a `connectionType`'s `resolve` function.
- `Relay::cursorForObjectInConnection` is a helper method that takes an array and a member object, and returns a cursor for use in the mutation payload.

An example usage of these methods from the [test schema](tests/StarWarsSchema.php):

```
$shipConnection = Relay::connectionDefinitions([
    'nodeType' => $shipType
]);

// this could also be written as
//
// $shipEdge = Relay::edgeType([
//     'nodeType' => $shipType
// ]);
// $shipConnection = Relay::connectionType([
//     'nodeType' => $shipType,
//     'edgeType' => $shipEdge
// ]);

$factionType = new ObjectType([
    'name' => 'Faction',
    'description' => 'A faction in the Star Wars saga',
    'fields' => function() use ($shipConnection) {
        return [
            'id' => Relay::globalIdField(),
            'name' => [
                'type' => Type::string(),
                'description' => 'The name of the faction.'
            ],
            'ships' => [
                'type' => $shipConnection['connectionType'],
                'description' => 'The ships used by the faction.',
                'args' => Relay::connectionArgs(),
                'resolve' => function($faction, $args) {
                    // Map IDs from faction back to ships
                    $data = array_map(function($id) {
                        return StarWarsData::getShip($id);
                    }, $faction['ships']);
                    return Relay::connectionFromArray($data, $args);
                }
            ]
        ];
    },
    'interfaces' => [$nodeDefinition['nodeInterface']]
]);
```

This shows adding a `ships` field to the `Faction` object that is a connection. It uses `connectionDefinitions({nodeType: shipType})` to create the connection type, adds `connectionArgs` as arguments on this function, and then implements the resolve function by passing the array of ships and the arguments to `connectionFromArray`.

### Object Identification

[](#object-identification)

Helper functions are provided for both building the GraphQL types for nodes and for implementing global IDs around local IDs.

- `Relay::nodeDefinitions` returns the `Node` interface that objects can implement, and returns the `node` root field to include on the query type. To implement this, it takes a function to resolve an ID to an object, and to determine the type of a given object.
- `Relay::toGlobalId` takes a type name and an ID specific to that type name, and returns a "global ID" that is unique among all types.
- `Relay::fromGlobalId` takes the "global ID" created by `toGlobalID`, and returns the type name and ID used to create it.
- `Relay::globalIdField` creates the configuration for an `id` field on a node.
- `Relay::pluralIdentifyingRootField` creates a field that accepts a list of non-ID identifiers (like a username) and maps then to their corresponding objects.

An example usage of these methods from the [test schema](tests/StarWarsSchema.php):

```
$nodeDefinition = Relay::nodeDefinitions(
    // The ID fetcher definition
    function ($globalId) {
        $idComponents = Relay::fromGlobalId($globalId);
        if ($idComponents['type'] === 'Faction'){
            return StarWarsData::getFaction($idComponents['id']);
        } else if ($idComponents['type'] === 'Ship'){
            return StarWarsData::getShip($idComponents['id']);
        } else {
            return null;
        }
    },
    // Type resolver
    function ($object) {
        return isset($object['ships']) ? self::getFactionType() : self::getShipType();
    }
);

$factionType = new ObjectType([
    'name' => 'Faction',
    'description' => 'A faction in the Star Wars saga',
    'fields' => function() use ($shipConnection) {
        return [
            'id' => Relay::globalIdField(),
            'name' => [
                'type' => Type::string(),
                'description' => 'The name of the faction.'
            ],
            'ships' => [
                'type' => $shipConnection['connectionType'],
                'description' => 'The ships used by the faction.',
                'args' => Relay::connectionArgs(),
                'resolve' => function($faction, $args) {
                    // Map IDs from faction back to ships
                    $data = array_map(function($id) {
                        return StarWarsData::getShip($id);
                    }, $faction['ships']);
                    return Relay::connectionFromArray($data, $args);
                }
            ]
        ];
    },
    'interfaces' => [$nodeDefinition['nodeInterface']]
]);

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => function () use ($nodeDefinition) {
        return [
            'node' => $nodeDefinition['nodeField']
        ];
    },
]);
```

This uses `Relay::nodeDefinitions` to construct the `Node` interface and the `node`field; it uses `fromGlobalId` to resolve the IDs passed in in the implementation of the function mapping ID to object. It then uses the `Relay::globalIdField` method to create the `id` field on `Faction`, which also ensures implements the `nodeInterface`. Finally, it adds the `node` field to the query type, using the `nodeField` returned by `Relay::nodeDefinitions`.

### Mutations

[](#mutations)

A helper function is provided for building mutations with single inputs and client mutation IDs.

- `Relay::mutationWithClientMutationId` takes a name, input fields, output fields, and a mutation method to map from the input fields to the output fields, performing the mutation along the way. It then creates and returns a field configuration that can be used as a top-level field on the mutation type.

An example usage of these methods from the [test schema](tests/StarWarsSchema.php):

```
$shipMutation = Relay::mutationWithClientMutationId([
    'name' => 'IntroduceShip',
    'inputFields' => [
        'shipName' => [
            'type' => Type::nonNull(Type::string())
        ],
        'factionId' => [
            'type' => Type::nonNull(Type::id())
        ]
    ],
    'outputFields' => [
        'ship' => [
            'type' => $shipType,
            'resolve' => function ($payload) {
                return StarWarsData::getShip($payload['shipId']);
            }
        ],
        'faction' => [
            'type' => $factionType,
            'resolve' => function ($payload) {
                return StarWarsData::getFaction($payload['factionId']);
            }
        ]
    ],
    'mutateAndGetPayload' => function ($input) {
        $newShip = StarWarsData::createShip($input['shipName'], $input['factionId']);
        return [
            'shipId' => $newShip['id'],
            'factionId' => $input['factionId']
        ];
    }
]);

$mutationType = new ObjectType([
    'name' => 'Mutation',
    'fields' => function () use ($shipMutation) {
        return [
            'introduceShip' => $shipMutation
        ];
    }
]);
```

This code creates a mutation named `IntroduceShip`, which takes a faction ID and a ship name as input. It outputs the `Faction` and the `Ship` in question. `mutateAndGetPayload` then gets an object with a property for each input field, performs the mutation by constructing the new ship, then returns an object that will be resolved by the output fields.

Our mutation type then creates the `introduceShip` field using the return value of `Relay::mutationWithClientMutationId`.

Contributing
------------

[](#contributing)

After cloning this repo, ensure dependencies are installed by running:

```
composer install
```

After developing, the full test suite can be evaluated by running:

```
bin/phpunit tests
```

###  Health Score

46

—

FairBetter than 93% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity56

Moderate usage in the ecosystem

Community29

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 68.3% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~253 days

Recently: every ~588 days

Total

12

Last Release

941d ago

PHP version history (2 changes)v0.1.0PHP >=5.4,<8.0-DEV

v0.6.0PHP ^7.1 || ^8.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/c2ed484f5bd4450f5db836eb37761f88cbc4a116238f7edd73aae8121268e7df?d=identicon)[ivome](/maintainers/ivome)

---

Top Contributors

[![ivome](https://avatars.githubusercontent.com/u/6703744?v=4)](https://github.com/ivome "ivome (43 commits)")[![aboks](https://avatars.githubusercontent.com/u/815524?v=4)](https://github.com/aboks "aboks (8 commits)")[![danez](https://avatars.githubusercontent.com/u/231804?v=4)](https://github.com/danez "danez (5 commits)")[![Tpt](https://avatars.githubusercontent.com/u/458123?v=4)](https://github.com/Tpt "Tpt (3 commits)")[![grenierdev](https://avatars.githubusercontent.com/u/2616923?v=4)](https://github.com/grenierdev "grenierdev (2 commits)")[![otzy](https://avatars.githubusercontent.com/u/11853333?v=4)](https://github.com/otzy "otzy (1 commits)")[![szepeviktor](https://avatars.githubusercontent.com/u/952007?v=4)](https://github.com/szepeviktor "szepeviktor (1 commits)")

---

Tags

apigraphqlRelay

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ivome-graphql-relay-php/health.svg)

```
[![Health](https://phpackages.com/badges/ivome-graphql-relay-php/health.svg)](https://phpackages.com/packages/ivome-graphql-relay-php)
```

###  Alternatives

[overblog/graphql-bundle

This bundle provides tools to build a GraphQL server in your Symfony App.

8027.9M28](/packages/overblog-graphql-bundle)[wp-graphql/wp-graphql-woocommerce

WooCommerce bindings for WPGraphQL

69146.8k](/packages/wp-graphql-wp-graphql-woocommerce)[rubix/server

Deploy your Rubix ML models to production with scalable stand-alone inference servers.

632.3k](/packages/rubix-server)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)