kevinoo/graphql-laravel-filters

此库扩展了 rebing/graphql-laravel 的功能,为 Laravel 应用中管理分页和应用于 GraphQL 查询的高级过滤提供了一整套解决方案。

1.0.0 2024-04-03 08:34 UTC

This package is auto-updated.

Last update: 2024-09-03 09:30:25 UTC


README

此库扩展了 "rebing/graphql-laravel" 的功能,为 Laravel 应用中管理分页和应用于 GraphQL 查询的高级过滤提供了一整套解决方案。

安装

使用 Composer 安装库

composer require kevinoo/graphql-laravel-filters

用法

要在 GraphQL 查询中使用分页,只需扩展此库提供的 AbstractPaginateQuery 类,并在查询解析器中使用它。

use kevinoo\GraphQL\Queries;

class MyCustomModelQuery extends AbstractPaginateQuery 
{
//    public const GENERIC_FILTERS = true;
//    public const TRASHED_FILTER = true;
//    public const MAX_LIMIT_RESULTS = 1000;

    protected $attributes = [
        'name' => 'Name of Query',
    ];

    public function getGraphQLType(): string
    {
        return 'Your GraphQL Type';
    }

    public function args(): array
    {
        return parent::args() + [
            'filters' => [
                'type' => GraphQL::type('Your GraphQL FilterInput'),
            ],
        ];
    }

    protected function resolveModelBuilder( array $args ): Builder
    {
        $builder = YourModel::query();

        $order_by = ($args['orders'] ?? []) ?: ['domain'=>'ASC'];
        foreach( $order_by as $column => $direction ){
            $builder->orderBy($column,$direction);
        }

        return $builder;
    }

    protected function getGenericFiltersKeys(): array
    {
        return [
            'your_input_key_1' => 'model_attribute_1', // Input value can be string, int, boolean or array
            'your_input_key_2' => new AdvancedSearch('model_attribute_to_apply_advanced_search'),
            'your_input_key_3_array' => 'model_attribute_2',
        ];
    }

    protected function getPipelineFiltersSteps(): array
    {
        return parent::getPipelineFiltersSteps() + [
            // Add your other custom filters class
        ];
    }
}

贡献

欢迎您为此项目做出贡献!