在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称(OpenSource Name):ivome/graphql-relay-php开源软件地址(OpenSource Url):https://github.com/ivome/graphql-relay-php开源编程语言(OpenSource Language):PHP 100.0%开源软件介绍(OpenSource Introduction):Relay Library for graphql-phpThis is a library to allow the easy creation of Relay-compliant servers using the graphql-php reference implementation of a GraphQL server. Note: The code is a port of the original graphql-relay js implementation from Facebook (With some minor PHP related adjustments and extensions) 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 and here Getting StartedA 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 for the Specification for GraphQL. This library is designed to work with the 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 on the Relay website. That overview describes a simple set of examples that exist as 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-phpInstall this repository via composer: composer require ivome/graphql-relay-php When building a schema for graphql-php, the provided library functions can be used to simplify the creation of Relay patterns. ConnectionsHelper functions are provided for both building the GraphQL types
for connections and for implementing the
An example usage of these methods from the test schema: $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 Object IdentificationHelper functions are provided for both building the GraphQL types for nodes and for implementing global IDs around local IDs.
An example usage of these methods from the test schema: $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 MutationsA helper function is provided for building mutations with single inputs and client mutation IDs.
An example usage of these methods from the test schema: $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 Our mutation type then creates the ContributingAfter 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 |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论