README

使用Laravel可筛选模型定义GraphQL模式以进行连接过滤。

安装

composer require simexis/laravel-graphql-filter

使用方法

在模型上使用Filterable特性

namespace App;
use Simexis\Filterable\Filterable;

class User extends Model
{
  use \Simexis\Filterable\FilterableTrait;
  
  protected $filterable = [
    'name' => Filterable::String
  ];
}

创建GraphQL User类型

namespace App\GraphQL\Type;

use App\User;
use GraphQL\Type\Definition\Type;
use Folklore\GraphQL\Support\Type as GraphQLType;

class User extends GraphQLType
{
  protected $attributes = [
    'name' => 'User'
  ];
  public function fields() {
    return [
      'id' => [
        'type' => Type::id(),
      ],
      'name' => [
        'type' => Type::string()
      ]
    ]
  }
}

创建GraphQL UserFilter类型。UserFilter的字段定义将自动填充到User::$filterable中的字段。

namespace App\GraphQL\Type;

use App\User;
use Simexis\GraphQLFilter\Type\FilterType;

class UserFilter extends FilterType
{
  protected $model = User::class;
}

创建用于列出User记录的GraphQL查询类型，使用User模型的筛选设置。

namespace App\GraphQL\Type;

use App\User;
use GraphQL;
use GraphQL\Type\Definition\Type;
use Folklore\GraphQL\Support\Query;

class UsersQuery extends Query
{
  protected $attributes = [
    'name' => 'users'
  ];
  public function type() {
    return Type::listOf(GraphQL::type('User'));
  }
  public function args() {
    return [
      'filter' => [
        'type' => GraphQL::type('UserFilter')
      ]
    ];
  }
  public function resolve($root, $args, $context) {
    return User::filter($args['filter'])->orderBy('name')->limit(10)->get();
  }
}

现在GraphQL查询可以使用Filterable::String规则来执行搜索。

query ListJohns {
  users (filter: { name_MATCH: 'john' }) {
    name
  }
}