new Deps

vendor/nuwave/lighthouse/src/Pagination/PaginateDirective.php

@@ -0,0 +1,148 @@
+<?php
+
+namespace Nuwave\Lighthouse\Pagination;
+
+use GraphQL\Language\AST\FieldDefinitionNode;
+use GraphQL\Language\AST\ObjectTypeDefinitionNode;
+use GraphQL\Type\Definition\ResolveInfo;
+use Illuminate\Contracts\Pagination\Paginator;
+use Nuwave\Lighthouse\Schema\AST\DocumentAST;
+use Nuwave\Lighthouse\Schema\Directives\BaseDirective;
+use Nuwave\Lighthouse\Schema\Values\FieldValue;
+use Nuwave\Lighthouse\Support\Contracts\FieldManipulator;
+use Nuwave\Lighthouse\Support\Contracts\FieldResolver;
+use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;
+
+class PaginateDirective extends BaseDirective implements FieldResolver, FieldManipulator
+{
+    public static function definition(): string
+    {
+        return /** @lang GraphQL */ <<<'GRAPHQL'
+"""
+Query multiple model entries as a paginated list.
+"""
+directive @paginate(
+  """
+  Which pagination style should be used.
+  """
+  type: PaginateType = PAGINATOR
+
+  """
+  Specify the class name of the model to use.
+  This is only needed when the default model detection does not work.
+  """
+  model: String
+
+  """
+  Point to a function that provides a Query Builder instance.
+  This replaces the use of a model.
+  """
+  builder: String
+
+  """
+  Apply scopes to the underlying query.
+  """
+  scopes: [String!]
+
+  """
+  Allow clients to query paginated lists without specifying the amount of items.
+  Overrules the `pagination.default_count` setting from `lighthouse.php`.
+  """
+  defaultCount: Int
+
+  """
+  Limit the maximum amount of items that clients can request from paginated lists.
+  Overrules the `pagination.max_count` setting from `lighthouse.php`.
+  """
+  maxCount: Int
+) on FIELD_DEFINITION
+
+"""
+Options for the `type` argument of `@paginate`.
+"""
+enum PaginateType {
+    """
+    Offset-based pagination, similar to the Laravel default.
+    """
+    PAGINATOR
+
+    """
+    Offset-based pagination like the Laravel "Simple Pagination", which does not count the total number of records.
+    """
+    SIMPLE
+
+    """
+    Cursor-based pagination, compatible with the Relay specification.
+    """
+    CONNECTION
+}
+GRAPHQL;
+    }
+
+    public function manipulateFieldDefinition(DocumentAST &$documentAST, FieldDefinitionNode &$fieldDefinition, ObjectTypeDefinitionNode &$parentType): void
+    {
+        $paginationManipulator = new PaginationManipulator($documentAST);
+
+        if ($this->directiveHasArgument('builder')) {
+            // This is done only for validation
+            $this->getResolverFromArgument('builder');
+        } else {
+            $paginationManipulator->setModelClass(
+                $this->getModelClass()
+            );
+        }
+
+        $paginationManipulator->transformToPaginatedField(
+            $this->paginationType(),
+            $fieldDefinition,
+            $parentType,
+            $this->defaultCount(),
+            $this->paginateMaxCount()
+        );
+    }
+
+    public function resolveField(FieldValue $fieldValue): FieldValue
+    {
+        return $fieldValue->setResolver(
+            function ($root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo): Paginator {
+                if ($this->directiveHasArgument('builder')) {
+                    $builderResolver = $this->getResolverFromArgument('builder');
+
+                    $query = $builderResolver($root, $args, $context, $resolveInfo);
+                } else {
+                    $query = $this->getModelClass()::query();
+                }
+
+                $query = $resolveInfo
+                    ->argumentSet
+                    ->enhanceBuilder(
+                        $query,
+                        $this->directiveArgValue('scopes', [])
+                    );
+
+                return PaginationArgs
+                    ::extractArgs($args, $this->paginationType(), $this->paginateMaxCount())
+                    ->applyToBuilder($query);
+            }
+        );
+    }
+
+    protected function paginationType(): PaginationType
+    {
+        return new PaginationType(
+            $this->directiveArgValue('type', PaginationType::PAGINATOR)
+        );
+    }
+
+    protected function defaultCount(): ?int
+    {
+        return $this->directiveArgValue('defaultCount')
+            ?? config('lighthouse.pagination.default_count');
+    }
+
+    protected function paginateMaxCount(): ?int
+    {
+        return $this->directiveArgValue('maxCount')
+            ?? config('lighthouse.pagination.max_count');
+    }
+}