amin3mej/yii2-graphql-data-provider

A data-provider that can used for connect to a graphql server.

v0.1.0 2019-07-05 22:23 UTC

Requires

• php: >=5.4.0
• yiisoft/yii2: ~2.0.13

GPL-3.0-or-later

• php
• yii2
• graphql
• yii2 graphql data provider
• yii2-data-provider

README

Yii2 GraphQL Data-Provider Extension

A helper for GraphQL that include QueryHelper and ActiveDataProvider for Yii2.

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist amin3mej/yii2-graphql-data-provider "*"

or add

"amin3mej/yii2-graphql-data-provider": "*"

to the require section of your composer.json.

Configuration

Component Setup

To access Query Component, you need to configure the components array in your application configuration:

'components' => [
    'graphql' => [
        'class' => 'amin3mej\graphql\GraphqlQuery',
        'defaultTarget' => [
            'github' => 'https://api.github.com/graphql',
            'graphqlhub' => 'https://www.graphqlhub.com/graphql',
        ],
        'customHeaders' => [
            'Content-Type' => 'application/graphql',
            'github' => [
                'Authorization' => 'Bearer ' . $params['github.graphqlToken'],
            ],
        ],
    ],
],

You can define your targets here to access them fast from your code.

Also you can define some headers here to add to the requests. if you fine a key directly in array, the key recognized as common header and It will send with all request. if you define an array with the same name with your target, it headers will used only for the target.

By default there are two headers:

[
    'Accept' => 'application/json',
    'Content-Type' => 'application/json'
]

But you can override them, by giving new headers with the same Array keys.

Usage:

Query:

const QUERY_CHECK = <<<QUERY
query test (\$userId: Int!){
  userInfo (userId: \$userId) {
    firstname
    lastname
    email
  }
}
QUERY;

$result = Yii::$app->graphql->execute(QUERY_CHECK, ['userId' => (int) $userId], 'github');

ActiveDataProvider:

use amin3mej\graphql\GraphqlDataProvider;

// If you want to use pagination in ActiveDataProvider, Set $offset and $limit in your query. Everything will be handled automatically.
const QUERY = <<<QUERY
query(\$limit: Int, \$offset: Int){
  categories (first: \$limit, skip: \$offset){
    id
    name
    icon
  }
}
QUERY;

$dataProvider = new GraphqlDataProvider([
    'query' => QUERY,
    'queryCallback' => 'data.categories', // How to access the array in responded query result? More: https://www.yiiframework.com/doc/guide/2.0/en/helper-array#getting-values
    'totalCountQuery' => 'query { categoriesConnection { aggregate { count } } }',
    'target' => 'prisma',
]);

return $this->render('index', [
    'dataProvider' => $dataProvider,
]);