Lighthouse

https://github.com/nuwave/lighthouse
Admin
Lighthouse is a PHP framework for building GraphQL servers in Laravel, with a schema-first approach...
Tokens:400,779
Snippets:2,797
Trust Score:8.4
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install GraphiQL DevTools

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Installs the GraphiQL development tool via Composer.

```shell
composer require mll-lab/laravel-graphiql
```

--------------------------------

### Query all users

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Example query to fetch all users with their id and name.

```graphql
{
  users {
    id
    name
  }
}
```

--------------------------------

### Query paginated posts

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Example query to fetch the first 10 posts with pagination info.

```graphql
{
  posts(first: 10) {
    data {
      id
      title
    }
    paginatorInfo {
      currentPage
      lastPage
    }
  }
}
```

--------------------------------

### Install Pusher PHP Library

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/subscriptions/getting-started.md

Required when using the Pusher driver for subscriptions. Run this Composer command to install the Pusher PHP Library for interacting with the Pusher HTTP API.

```bash
composer require pusher/pusher-php-server
```

--------------------------------

### Install Lighthouse via Composer

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Use this command to install the Lighthouse package via Composer.

```shell
composer require nuwave/lighthouse
```

--------------------------------

### Configure federated tracing driver

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/federation/getting-started.md

Sets the tracing driver to FederatedTracing in config/lighthouse.php. Requires google/protobuf to be installed.

```php
'tracing' => [
    'driver' => Nuwave\Lighthouse\Tracing\FederatedTracing\FederatedTracing::class,
],
```

--------------------------------

### JSON response for createUser mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Example response showing the newly created user's id and name.

```json
{
  "data": {
    "createUser": {
      "id": "123",
      "name": "Donald"
    }
  }
}
```

--------------------------------

### Print schema with federation option

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/federation/getting-started.md

Generates a .graphql schema file suitable for publishing with federation support.

```shell
php artisan lighthouse:print-schema --federation
```

--------------------------------

### Test GraphQL query in GraphiQL

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

A sample query to verify the setup. Access /graphiql and run this query.

```graphql
{
  user(id: 1) {
    id
    name
    email
  }
}
```

--------------------------------

### JSON response for user query

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Example response when the user is found, showing the user's id and name.

```json
{
  "data": {
    "user": {
      "id": "69420",
      "name": "Chuck Norris"
    }
  }
}
```

--------------------------------

### Make setup command

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Sets up the local development environment using Docker and Make. Run in the project root after cloning.

```bash
make setup
```

--------------------------------

### Enable Apollo Federation v2 with @link

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/federation/getting-started.md

Opt-in to Apollo Federation v2 by adding this schema extension. Imports the required directives.

```graphql
extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: [
      "@composeDirective"
      "@extends"
      "@external"
      "@inaccessible"
      "@interfaceObject"
      "@key"
      "@override"
      "@provides"
      "@requires"
      "@shareable"
      "@tag"
    ]
  )
```

--------------------------------

### Install graphql-cli and retrieve schema

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/migrating-to-lighthouse.md

Use graphql-cli to install, initialize, and fetch an existing GraphQL schema from an endpoint. This helps migrate an existing API by saving the schema to a file.

```bash
npm install -g graphql-cli
```

```bash
graphql init
```

```bash
graphql get-schema --endpoint=example.com/graphql --output=schema.graphql
```

--------------------------------

### Response for users query

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Expected JSON response for the users query, showing a list of users.

```json
{
  "data": {
    "users": [
      { "id": 1, "name": "James Bond" },
      { "id": 2, "name": "Madonna" }
    ]
  }
}
```

--------------------------------

### Run database migrations

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Creates the users table in the database. Run after setting up a working database connection.

```shell
php artisan migrate
```

--------------------------------

### Publish Default Schema

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Publishes the default schema included with Lighthouse using the artisan command.

```shell
php artisan vendor:publish --tag=lighthouse-schema
```

--------------------------------

### GraphQL query calling greet with argument

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Calls the greet query, passing a name argument of "Foo".

```graphql
{
  greet(name: "Foo")
}
```

--------------------------------

### Copy Lighthouse Config for Lumen

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Copies the Lighthouse configuration file to the config folder for Lumen projects.

```shell
mkdir --parents config
cp vendor/nuwave/lighthouse/src/lighthouse.php config/
```

--------------------------------

### Register Lighthouse Service Provider in Lumen

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Registers the Lighthouse service provider in the Lumen bootstrap/app.php file.

```php
$app->register(\Nuwave\Lighthouse\LighthouseServiceProvider::class);
```

--------------------------------

### JSON response for greet query

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Expected JSON response when calling greet with name "Foo".

```json
{
  "data": {
    "greet": "Hello, Foo!"
  }
}
```

--------------------------------

### Configure Lighthouse in Lumen bootstrap/app.php

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Registers the Lighthouse config file in the Lumen bootstrap/app.php file.

```php
$app->configure('lighthouse');
```

--------------------------------

### Generate Post model and migration

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Runs the artisan command to create a Post model and its migration file.

```shell
php artisan make:model -m Post
```

--------------------------------

### Copy Default Schema for Lumen

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Copies the default schema file to the graphql folder for Lumen projects.

```shell
mkdir --parents graphql
cp vendor/nuwave/lighthouse/src/default-schema.graphql graphql/schema.graphql
```

--------------------------------

### SQL query generated by @all with scope

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Shows the SQL query produced when using the @all directive with the 'verified' scope.

```sql
SELECT * FROM `users` WHERE `email_verified_at` IS NOT NULL
```

--------------------------------

### Example updateUser mutation and response

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Shows a GraphQL mutation to update a user by ID and the expected JSON response. The update may return null if the model is not found.

```graphql
mutation {
  updateUser(id: "123", name: "Hillary") {
    id
    name
  }
}
```

```json
{
  "data": {
    "updateUser": {
      "id": "123",
      "name": "Hillary"
    }
  }
}
```

--------------------------------

### Create test file

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/file-uploads.md

Creates a file to upload for testing the example.

```shell
echo "test content" > my_file.txt
```

--------------------------------

### Generate Comment model and migration

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Runs the artisan command to create a Comment model and its migration file.

```shell
php artisan make:model -m Comment
```

--------------------------------

### GraphQL query selecting user fields

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Client query that requests the id and name fields of the user.

```graphql
{
  user {
    id
    name
  }
}
```

--------------------------------

### GraphQL query for user by email

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Queries the user field with an email argument to find a user.

```graphql
{
  user(email: "chuck@nor.ris") {
    id
    name
  }
}
```

--------------------------------

### Composer install

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Installs PHP dependencies when using native tools instead of Docker. Run in the project root.

```bash
composer install
```

--------------------------------

### Custom GraphQLContext implementation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/extending-lighthouse.md

Replace the default Nuwave\Lighthouse\Schema\Context with your own implementation of the GraphQLContext interface. The example shows a starting point with a request method and a user method to implement yourself.

```php
namespace Nuwave\Lighthouse\Schema;

use Illuminate\Http\Request;
use Illuminate\Contracts\Auth\Authenticatable;
use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;

final class MyContext implements GraphQLContext
{
    public function __construct(
        public Request $request
    ) {}

    public function request(): Request
    {
        return $this->request;
    }

    public function user(): ?Authenticatable
    {
        // TODO implement yourself
    }
}
```

--------------------------------

### Create a user with @create

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL mutation that creates a new user with the given name. The mutation returns the newly created user object.

```APIDOC
## [MUTATION] createUser(name: String!): User! @create

### Description
Creates a new user with the provided name. The mutation uses the arguments to create a new model instance and returns the created user.

### Method
MUTATION

### Endpoint
createUser(name: String!): User! @create

### Parameters
#### Arguments
- **name** (String!) - Required - The name of the user to create.

### Request Example
```graphql
mutation {
  createUser(name: "Donald") {
    id
    name
  }
}
```

### Response
#### Success Response
- **id** (ID) - The ID of the newly created user.
- **name** (String) - The name of the newly created user.

#### Response Example
```json
{
  "data": {
    "createUser": {
      "id": "123",
      "name": "Donald"
    }
  }
}
```
```

--------------------------------

### Print schema before and after upgrade

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Commands to print the schema before and after upgrading, and to compare the changes with graphql-inspector.

```bash
php artisan lighthouse:print-schema > old.graphql
```

```bash
php artisan lighthouse:print-schema > new.graphql
```

```bash
graphql-inspector diff old.graphql new.graphql
```

--------------------------------

### GraphQL query for hello field

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Queries the 'hello' field to retrieve its value. This is the client-side query that triggers the resolver.

```graphql
{
  hello
}
```

--------------------------------

### Register Pagination and Validation Service Providers in Lumen

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/getting-started/installation.md

Registers the Pagination and Validation service providers required by the default schema in Lumen.

```php
$app->register(\Nuwave\Lighthouse\Pagination\PaginationServiceProvider::class);
$app->register(\Nuwave\Lighthouse\Validation\ValidationServiceProvider::class);
```

--------------------------------

### Retrieve all models with @all directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Uses the @all directive to automatically resolve a query field with Eloquent, assuming the model name matches the return type.

```graphql
type Query {
  users: [User!]! @all
}
```

--------------------------------

### JSON response for hello query

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

The expected response from the GraphQL query for the 'hello' field, returning the value 'world!'.

```json
{
  "data": {
    "hello": "world!"
  }
}
```

--------------------------------

### Unsupported: Namespaced directives without import

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/federation/getting-started.md

Using directives from a namespace without an import is not supported. Directives must be imported and used with default names.

```graphql
extend schema
  @link(url: "https://specs.apollo.dev/federation/v2.3", import: ["@key"])

type Book @federation__shareable {
  title: String!
}
```

--------------------------------

### @include usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/client-directives.md

Queries `experimentalField` only when the variable `$someTest` is `true`.

```graphql
query myQuery($someTest: Boolean) {
  experimentalField @include(if: $someTest)
}

```

--------------------------------

### Make help command

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Lists available development commands defined in the Makefile. Run in the project root after cloning.

```bash
make help
```

--------------------------------

### Comments table migration

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Migration for the comments table with id, post_id, reply, and timestamps. Replace the generated create_comments_table.php with this.

```php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

return new class() extends Migration {
    public function up(): void
    {
        Schema::create('comments', function (Blueprint $table) {
            $table->id('id');
            $table->unsignedBigInteger('post_id');
            $table->string('reply');
            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('comments');
    }
};
```

--------------------------------

### Install mll-lab/graphql-php-scalars dependency

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/complex-where-conditions.md

Run this Composer command to install the required dependency for the WhereConditions extension.

```shell
composer require mll-lab/graphql-php-scalars
```

--------------------------------

### User model with posts relation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Adds a posts relation to the User model. Replace app/Models/User.php with this complete file.

```php
namespace App\Models;

use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Foundation\Auth\User as Authenticatable;
use Illuminate\Notifications\Notifiable;
use Laravel\Sanctum\HasApiTokens;

final class User extends Authenticatable
{
    use HasApiTokens, HasFactory, Notifiable;

    /**
     * The attributes that are mass assignable.
     *
     * @var array<int, string>
     */
    protected $fillable = [
        'name',
        'email',
        'password',
    ];

    /**
     * The attributes that should be hidden for arrays.
     *
     * @var array<int, string>
     */
    protected $hidden = [
        'password',
        'remember_token',
    ];

    /**
     * The attributes that should be cast to native types.
     *
     * @var array<string, string|\Illuminate\Contracts\Database\Eloquent\Castable>
     */
    protected $casts = [
        'email_verified_at' => 'datetime',
    ];

    public function posts(): HasMany
    {
        return $this->hasMany(Post::class, 'author_id');
    }
}
```

--------------------------------

### @nest usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/api-reference/directives.md

Demonstrates using @nest to group arg resolvers. The example shows a Mutation with a nested input object that uses @create to create related tasks.

```graphql
type Mutation {
  createUser(name: String, tasks: UserTasksOperations @nest): User! @create
}

input UserTasksOperations {
  newTask: CreateTaskInput @create(relation: "tasks")
}

input CreateTaskInput {
  name: String
}

type Task {
  name: String!
}

type User {
  name: String
  tasks: [Task!]! @hasMany
}
```

--------------------------------

### Unsupported: Renaming imported directives

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/federation/getting-started.md

Renaming imported directives is not supported; only default names can be used. This example shows an attempt that is not supported.

```graphql
extend schema
  @link(
    url: "https://specs.apollo.dev/federation/v2.3"
    import: [{ name: "@key", as: "@uniqueKey" }, "@shareable"]
  )
```

--------------------------------

### Response of deleteUser mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Example JSON response showing the deleted user's data, including the secret field. The mutation returns the deleted object.

```json
{
  "data": {
    "deleteUser": {
      "secret": "Pink is my favorite color!"
    }
  }
}
```

--------------------------------

### Example upsertUser mutation and response

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Shows a GraphQL mutation to upsert a user by ID and the expected JSON response. The email field is nullable and may be null in the response.

```graphql
mutation {
  upsertUser(id: "123", name: "Hillary") {
    id
    name
    email
  }
}
```

```json
{
  "data": {
    "upsertUser": {
      "id": "123",
      "name": "Hillary",
      "email": null
    }
  }
}
```

--------------------------------

### Configure Pusher encryption options

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/subscriptions/getting-started.md

Add these options to config/broadcasting.php to enable encrypted subscriptions for the Pusher driver. The encryption_master_key_base64 value should be generated with 'openssl rand -base64 32'.

```php
// in config/broadcasting.php
'options' => [
  'useTLS' => true,
  'encryption_master_key_base64' => 'YOUR_MASTER_KEY', // generate this with, e.g. 'openssl rand -base64 32'
],
```

--------------------------------

### Artisan command to generate resolver

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Generates a resolver class for the 'hello' field using the lighthouse:query artisan command. The command takes the field name as its single argument.

```shell
php artisan lighthouse:query Hello
```

--------------------------------

### @skip usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/client-directives.md

Queries `experimentalField` only when the variable `$someTest` is `false`.

```graphql
query myQuery($someTest: Boolean) {
  experimentalField @skip(if: $someTest)
}

```

--------------------------------

### GraphQL query calling greet without argument

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Calls the greet query without providing the name argument, relying on the default value.

```graphql
{
  greet
}
```

--------------------------------

### Define User and Post types with SDL

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Example schema definition using GraphQL SDL to define a User type with a one-to-many relationship to Post, and the inverse relationship from Post to User via the author field.

```graphql
type User {
  id: ID!
  name: String!
  posts: [Post!]!
}

type Post {
  title: String!
  author: User!
}
```

--------------------------------

### Transformed schema for pagination

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

The schema definition is automatically transformed to this paginated structure.

```graphql
type Query {
  posts(first: Int!, page: Int): PostPaginator
}

type PostPaginator {
  data: [Post!]!
  paginatorInfo: PaginatorInfo!
}
```

--------------------------------

### Posts table migration

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Migration for the posts table with id, author_id, title, content, and timestamps. Replace the generated create_posts_table.php with this.

```php
use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

return new class() extends Migration {
    public function up(): void
    {
        Schema::create('posts', function (Blueprint $table) {
            $table->id('id');
            $table->unsignedBigInteger('author_id');
            $table->string('title');
            $table->string('content');
            $table->timestamps();
        });
    }

    public function down(): void
    {
        Schema::dropIfExists('posts');
    }
};
```

--------------------------------

### @hash usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/api-reference/directives.md

Shows the common use case of hashing a password argument in a mutation.

```graphql
type Mutation {
  createUser(name: String!, password: String! @hash): User!
}
```

--------------------------------

### JSON response for greet query without argument

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Expected JSON response when calling greet without an argument, using the default value.

```json
{
  "data": {
    "greet": "Hello, you!"
  }
}
```

--------------------------------

### Use native interface for errors with extensions

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Use GraphQL\Error\ProvidesExtensions::getExtensions() over Nuwave\Lighthouse\Exceptions\RendersErrorsExtensions::extensionsContent() to return extra information from exceptions.

```diff
use Exception;
-use Nuwave\Lighthouse\Exceptions\RendersErrorsExtensions;
+use GraphQL\Error\ClientAware;
+use GraphQL\Error\ProvidesExtensions;

-class CustomException extends Exception implements RendersErrorsExtensions
+class CustomException extends Exception implements ClientAware, ProvidesExtensions
{
-   public function extensionsContent(): array
+   public function getExtensions(): array
```

--------------------------------

### Create a post with GraphQL mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Use this mutation to create a post for a user. The author is connected via the `connect` input with the user's ID (e.g., 1).

```graphql
mutation {
  createPost(
    input: { title: "Hello", content: "World", author: { connect: 1 } }
  ) {
    id
  }
}
```

--------------------------------

### PHP resolver class for greet query

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Minimal resolver implementation for the greet field. The second argument is an associative array of query arguments. The class skeleton can be generated with `php artisan lighthouse:query Greet`.

```php
namespace App\GraphQL\Queries;

final class Greet
{
    public function __invoke(mixed $root, array $args): string
    {
        return "Hello, {$args['name']}!";
    }
}
```

--------------------------------

### GraphQL mutation to create a user

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Mutation that creates a user with the name 'Donald' and returns the id and name.

```graphql
mutation {
  createUser(name: "Donald") {
    id
    name
  }
}
```

--------------------------------

### Array alignment example (correct and incorrect)

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Shows correct and incorrect horizontal alignment in arrays. Avoid aligning values horizontally to prevent ugly diffs.

```php
// Right
[
    'foo' => 1,
    'barbaz' => 2,
]

// Wrong
[
    'foo'    => 1,
    'barbaz' => 2,
]
```

--------------------------------

### Seed database with fake users

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Uses Laravel Tinker to create 10 fake users via the User factory. Run after migrations.

```shell
php artisan tinker
\App\Models\User::factory(10)->create()
```

--------------------------------

### Use ResolveInfo::enhanceBuilder()

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

ArgumentSet::enhanceBuilder() was removed. You must now call ResolveInfo::enhanceBuilder() and pass the resolver arguments.

```diff
use Nuwave\Lighthouse\Execution\ResolveInfo;
use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;

// Some resolver function or directive middleware
function (mixed $root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) {
-   $resolveInfo->argumentSet->enhanceBuilder($builder, $scopes, $directiveFilter);
+   $resolveInfo->enhanceBuilder($builder, $scopes, $root, $args, $context, $resolveInfo, $directiveFilter);
```

--------------------------------

### Paginate posts with @paginate directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Uses the @paginate directive to query a large list of models in chunks.

```graphql
type Query {
  posts: [Post!]! @paginate
}
```

--------------------------------

### @whereKey usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/api-reference/directives.md

Shows how to use @whereKey with @find, @all, and @delete directives to filter queries and mutations by primary key.

```graphql
```graphql
type Query {
  post(id: ID! @whereKey): Post @find
  posts(ids: [ID!]! @whereKey): [Post!]! @all
}

type Mutation {
  deletePost(id: ID! @whereKey): Post! @delete
}
```
```

--------------------------------

### HasMany: Response for create user mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/nested-mutations.md

Example JSON response showing the created user and their posts with IDs.

```json
{
  "data": {
    "createUser": {
      "id": 23,
      "posts": [
        {
          "id": 434
        },
        {
          "id": 435
        }
      ]
    }
  }
}
```

--------------------------------

### Delete a post with deletePost mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Remove a post by its ID. Returns the ID of the deleted post.

```graphql
mutation {
  deletePost(id: 1) {
    id
  }
}
```

--------------------------------

### GraphQL mutation definition with @create

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a Mutation field that creates a new user using the @create directive.

```graphql
type Mutation {
  createUser(name: String!): User! @create
}
```

--------------------------------

### deleteUser Mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Deletes a user by ID using the @delete directive. Returns the deleted object for a final look at the data.

```APIDOC
## [MUTATION] deleteUser

### Description
Deletes a user by ID using the @delete directive. Returns the deleted object for a final look at the data.

### Method
Mutation

### Endpoint
GraphQL Mutation: deleteUser

### Parameters
#### Arguments
- **id** (ID!) - Required - The ID of the user to delete.

### Request Example
```graphql
mutation {
  deleteUser(id: "123") {
    secret
  }
}
```

### Response
#### Success Response
- **secret** (String) - The secret field of the deleted user.

#### Response Example
```json
{
  "data": {
    "deleteUser": {
      "secret": "Pink is my favorite color!"
    }
  }
}
```
```

--------------------------------

### GraphQL schema with required argument

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Defines a Query type with a greet field that requires a non-null String argument named name.

```graphql
type Query {
  greet(name: String!): String
}
```

--------------------------------

### Warm SubscriptionRegistry in Laravel Octane

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/subscriptions/getting-started.md

Add this to config/octane.php when using subscriptions with Laravel Octane to ensure the subscription registry is warmed.

```php
    'warm' => [
        ...Octane::defaultServicesToWarm(),
        Nuwave\Lighthouse\Subscriptions\SubscriptionRegistry::class,
    ],
```

--------------------------------

### Use GraphQL\Language\Parser instead of PartialParser

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Replace the use statement for Nuwave\Lighthouse\Schema\AST\PartialParser with GraphQL\Language\Parser. Most methods work the same, but some have different names.

```diff
-use Nuwave\Lighthouse\Schema\AST\PartialParser;
+use GraphQL\Language\Parser;
```

--------------------------------

### Call deleteUser mutation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Invokes the deleteUser mutation with a specific ID. The response includes the deleted object's secret field.

```graphql
mutation {
  deleteUser(id: "123") {
    secret
  }
}
```

--------------------------------

### PHPDoc generic type hint for Collection

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Example of using the generic type hint style for aggregate types like Collection, which is understood by PhpStorm and most other editors.

```php
/**
 * Hint at the contents of the Collection.
 *
 * @return \Illuminate\Support\Collection<string>
 */
function foo(): Collection
```

--------------------------------

### upsertUser

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Updates a model with the given id or creates it if it does not exist, using the @upsert directive. Optionally, custom identifying columns can be specified.

```APIDOC
## [MUTATION] upsertUser

### Description
Updates a model with the given id or creates it if it does not exist, using the @upsert directive. Optionally, custom identifying columns can be specified.

### Method
Mutation

### Endpoint
upsertUser

### Parameters
#### Arguments
- **id** (ID) - Optional - The ID of the model to update. If not provided, a new model is created.
- **name** (String!) - Required - The name field.
- **email** (String) - Optional - The email field.

### Request Example
```graphql
mutation {
  upsertUser(id: "123", name: "Hillary") {
    id
    name
    email
  }
}
```

### Response
#### Success Response
- **id** (ID) - The ID of the upserted model.
- **name** (String) - The name of the upserted model.
- **email** (String) - The email of the upserted model.

#### Response Example
```json
{
  "data": {
    "upsertUser": {
      "id": "123",
      "name": "Hillary",
      "email": null
    }
  }
}
```
```

--------------------------------

### GraphQL field definition using @all with scopes

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a Query field that uses the @all directive with the 'verified' scope to return only verified users.

```graphql
type Query {
  users: [User]! @all(scopes: ["verified"])
}
```

--------------------------------

### Artisan command to generate field resolver

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Command to generate a resolver class for the field `name` on type `User` using the built-in `lighthouse:field` artisan command.

```shell
php artisan lighthouse:field User.name
```

--------------------------------

### PHP Eloquent model with local scope

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a local scope 'verified' in a User model to filter users with a non-null email_verified_at.

```php
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

final class User extends Model
{
    public function scopeVerified(Builder $query): Builder
    {
        return $query->whereNotNull('email_verified_at');
    }
}
```

--------------------------------

### Query posts with author and comments

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Fetch all posts along with their comments and author names. Returns a list of posts with nested author and comments data.

```graphql
{
  posts {
    id
    title
    author {
      name
    }
    comments {
      id
      reply
    }
  }
}
```

--------------------------------

### PHP resolver using ResolveInfo for dynamic field access

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Resolver that uses the fourth argument ResolveInfo to dynamically access the matching property on the User model. This avoids writing repetitive resolvers for each field.

```php
use App\Models\User;
use Nuwave\Lighthouse\Execution\ResolveInfo;
use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;

function resolveUserAttribute(User $user, array $args, GraphQLContext $context, ResolveInfo $resolveInfo)
{
    return $user->{$resolveInfo->fieldName};
}
```

--------------------------------

### GraphQL schema for hello field

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Defines the root Query type with a single field 'hello' returning a String. This is the schema that Lighthouse uses to generate the resolver.

```graphql
type Query {
  hello: String!
}
```

--------------------------------

### GraphQL schema with optional argument and default value

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Modifies the greet field to make the name argument optional with a default value of "you".

```graphql
type Query {
  greet(name: String = "you"): String
}
```

--------------------------------

### updateUser

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Updates an existing model using the @update directive. The id argument is required to identify the model, while other fields are optional for partial updates.

```APIDOC
## [MUTATION] updateUser

### Description
Updates an existing model using the @update directive. The id argument is required to identify the model, while other fields are optional for partial updates.

### Method
Mutation

### Endpoint
updateUser

### Parameters
#### Arguments
- **id** (ID!) - Required - The ID of the model to update.
- **name** (String) - Optional - The new value for the name field.

### Request Example
```graphql
mutation {
  updateUser(id: "123", name: "Hillary") {
    id
    name
  }
}
```

### Response
#### Success Response
- **id** (ID) - The ID of the updated model.
- **name** (String) - The updated name.

#### Response Example
```json
{
  "data": {
    "updateUser": {
      "id": "123",
      "name": "Hillary"
    }
  }
}
```

#### Error Response
If the model is not found, the mutation returns `null`.

```json
{
  "data": {
    "updateUser": null
  }
}
```
```

--------------------------------

### Upgrade mll-lab/graphql-php-scalars to v4

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

If you use complex where condition directives such as @whereConditions, upgrade mll-lab/graphql-php-scalars to version 4 using Composer.

```bash
composer require mll-lab/graphql-php-scalars:^4
```

--------------------------------

### Update failure response returning null

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Shows the JSON response when the update fails to find the model, returning null for the updateUser field.

```json
{
  "data": {
    "updateUser": null
  }
}
```

--------------------------------

### GraphQL field definition with @eq directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a Query field that allows clients to find a user by email using the @eq directive.

```graphql
type Query {
  user(email: String! @eq): User @find
}
```

--------------------------------

### Response for connecting existing author

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/nested-mutations.md

Example JSON response showing the created Post with id 456 and the connected author's name.

```json
{
  "data": {
    "createPost": {
      "id": 456,
      "author": {
        "name": "Herbert"
      }
    }
  }
}
```

--------------------------------

### PHP resolver class for hello field

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Implements the resolver for the 'hello' field. The class must be named after the field (capitalized) and placed in App\GraphQL\Queries. The __invoke method returns the string 'world!'.

```php
namespace App\GraphQL\Queries;

final class Hello
{
    public function __invoke(): string
    {
        return 'world!';
    }
}
```

--------------------------------

### Define Eloquent model as GraphQL type

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Maps an Eloquent model to a GraphQL type. The primary key field should be named `id` for client-side caching.

```graphql
type User {
  id: ID!
  name: String!
}
```

--------------------------------

### UserPostsBatchLoader Implementation

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/performance/n-plus-one.md

Example batch loader implementation that queues users, resolves posts in one call, and returns a Deferred. It ensures the actual loading happens only once.

```php
use GraphQL\Deferred;

final class UserPostsBatchLoader
{
    /**
     * Map from user IDs to users.
     *
     * @var array<int, \App\Models\User>
     */
    protected array $users = [];

    /**
     * Map from user IDs to posts.
     *
     * @var array<int, array<int, \App\Models\Post>>
     */
    protected array $results = [];

    /**
     * Marks when the actual batch loading happened.
     */
    protected bool $hasResolved = false;

    /**
     * Queue loading of posts for the given user.
     */
    public function load(User $user): Deferred
    {
        $this->users[$user->id] = $user;

        // The wrapped callable will run after load() has been called
        // with all users in the current query.
        return new Deferred(function () use ($user): array {
            // Ensure we only perform the actual loading exactly once.
            if (! $this->hasResolved) {
                $this->resolve();
            }

            return $this->results[$user->id];
        });
    }

    /**
     * Actually call out to the posts service and resolve them all at once.
     */
    protected function resolve(): void
    {
        $posts = PostsService::forUsers(array_keys($this->users));

        foreach ($posts as $post) {
            $this->results[$post->user_id][] = $post;
        }

        $this->hasResolved = true;
    }
}
```

--------------------------------

### Use graphQLSubscriptionMock for broadcast assertions

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/testing/phpunit.md

Shows how to use graphQLSubscriptionMock to get a spy for more control over broadcast assertions. The example checks that no broadcast was received, optionally filtering by channel.

```php
$spy = $response->graphQLSubscriptionMock($this);

$spy->shouldNotHaveReceived('broadcast');
// or
$spy->shouldNotHaveReceived('broadcast', function (Subscriber $subscriber, $broadcastedData) use ($response): bool {
    $channel = $response->graphQLSubscriptionChannelName();
    return $channel !== $subscriber->channel;
});
```

--------------------------------

### Instantiate ClientDirective class

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/client-directives.md

Create a `ClientDirective` instance to retrieve information about where client directives were placed in the query and their arguments.

```php
$clientDirective = new \Nuwave\Lighthouse\ClientDirectives\ClientDirective('example');

```

--------------------------------

### Run benchmarks

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Runs the reports defined in phpbench.json via the command line.

```bash
make bench
```

--------------------------------

### Pusher expiration webhook URL

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/subscriptions/getting-started.md

The webhook URL to configure in the Pusher Dashboard for channel existence events. When a channel is vacated, Lighthouse deletes the subscription.

```text
/graphql/subscriptions/webhook
```

--------------------------------

### Copy PHPUnit configuration

Source: https://github.com/nuwave/lighthouse/blob/master/CONTRIBUTING.md

Creates a local phpunit.xml from the distribution file. After copying, adjust the env parameters to connect to MySQL and Redis test instances.

```bash
cp phpunit.xml.dist phpunit.xml
```

--------------------------------

### GraphQL query for posts with author

Source: https://github.com/nuwave/lighthouse/blob/master/docs/INDEX.md

Example query that fetches posts and their authors, demonstrating how clients can request exactly the data they need.

```graphql
query PostsWithAuthor {
  posts {
    title
    author {
      name
    }
  }
}
```

--------------------------------

### Use native TestResponse::json()

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Replace the removed jsonGet() mixin with the native ->json() method, supported by Laravel starting from version 5.6.

```diff
$response = $this->graphQL(...);
-$response->jsonGet(...);
+$response->json(...);
```

--------------------------------

### Implement defaultHasOperator in custom operator

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

If you implement your own custom operator, implement the defaultHasOperator method. This example shows the implementation from the default SQLOperator, which returns 'GTE'.

```php
public function defaultHasOperator(): string
{
    return 'GTE';
}
```

--------------------------------

### Set up in-memory defer stream with setUpDeferStream()

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/testing/phpunit.md

Use setUpDeferStream() to manually set up the in-memory stream for testing @defer fields.

```php
$this->setUpDeferStream();
```

--------------------------------

### GraphQL schema with non-root fields

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/the-basics/fields.md

Defines a Query type with a user field returning a User type, which has id, name, and email fields.

```graphql
type Query {
  user: User!
}

type User {
  id: ID!
  name: String!
  email: String
}
```

--------------------------------

### Query all users with local scope

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL query field that returns all users, applying a local scope 'verified' to filter results. The scope adds a WHERE clause to the query.

```APIDOC
## [QUERY] users: [User]! @all(scopes: ["verified"])

### Description
Returns a list of users, applying the 'verified' local scope to filter out unverified users. The scope adds a WHERE clause to the query.

### Method
QUERY

### Endpoint
users: [User]! @all(scopes: ["verified"])

### Parameters
#### Arguments
- **scopes** (String[]) - Required - The list of local scopes to apply. In this example, 'verified' is used.

### Response
#### Success Response
- **users** ([User]!) - A list of verified users.

#### Response Example
```sql
SELECT * FROM `users` WHERE `email_verified_at` IS NOT NULL
```
```

--------------------------------

### Add posts queries to Query type

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Adds two queries to the root Query type: posts returns all Post models via @all, and post retrieves a single Post by ID using @find and @eq.

```diff
type Query {
   ...
+  posts: [Post!]! @all
+  post(id: Int! @eq): Post @find
}
```

--------------------------------

### Define delete mutation with @delete directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL mutation that deletes a user by ID using the @delete directive and @whereKey argument. The mutation returns the deleted User object.

```graphql
type Mutation {
  deleteUser(id: ID! @whereKey): User @delete
}
```

--------------------------------

### Define upsertUser mutation with @upsert directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL mutation type using the @upsert directive to update a model by ID or create it if it does not exist. Minimum required fields should be non-nullable.

```graphql
type Mutation {
  upsertUser(id: ID, name: String!, email: String): User! @upsert
}
```

--------------------------------

### Run a subscription query with graphQL helper

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/testing/phpunit.md

Runs a subscription query using the `graphQL` helper, similar to regular queries.

```php
public function testPostsSubscription(): void
{
    $response = $this->graphQL(/** @lang GraphQL */ <<<'GRAPHQL'
    {
        subscription {
            onPostCreated {
                title
            }
        }
    }
    GRAPHQL);
}
```

--------------------------------

### Define updateUser mutation with @update directive

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL mutation type using the @update directive to update a single model by ID. All arguments except id should be optional to support partial updates.

```graphql
type Mutation {
  updateUser(id: ID!, name: String): User! @update
}
```

--------------------------------

### Post model with author and comments relations

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Defines the Post model with a BelongsTo relation to User (as author) and a HasMany relation to Comment. Replace the generated app/Models/Post.php with this.

```php
namespace App\Models;

use Illuminate\Database\Eloquent\Relations\HasMany;
use Illuminate\Database\Eloquent\Relations\BelongsTo;

final class Post extends Model
{
    public function author(): BelongsTo
    {
        return $this->belongsTo(User::class, 'author_id');
    }

    public function comments(): HasMany
    {
        return $this->hasMany(Comment::class);
    }
}
```

--------------------------------

### Query user by email with @eq

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL query field that allows clients to find a user by their email using the @eq directive. The query returns the user's id and name if found.

```APIDOC
## [QUERY] user(email: String! @eq): User @find

### Description
Find a user by their email address using the @eq directive. Returns the user object if found.

### Method
QUERY

### Endpoint
user(email: String! @eq): User @find

### Parameters
#### Arguments
- **email** (String!) - Required - The email address of the user to find.

### Request Example
```graphql
{
  user(email: "chuck@nor.ris") {
    id
    name
  }
}
```

### Response
#### Success Response
- **id** (ID) - The user's ID.
- **name** (String) - The user's name.

#### Response Example
```json
{
  "data": {
    "user": {
      "id": "69420",
      "name": "Chuck Norris"
    }
  }
}
```
```

--------------------------------

### Replace ClearsSchemaCache with RefreshesSchemaCache in TestCase

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Update the testing trait to avoid race conditions in parallel tests. Replace the import, trait usage, and setUp call with the new RefreshesSchemaCache equivalents.

```diff
-use Nuwave\Lighthouse\Testing\ClearsSchemaCache;
+use Nuwave\Lighthouse\Testing\RefreshesSchemaCache;
use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;
-   use ClearsSchemaCache;
+   use RefreshesSchemaCache;

    protected function setUp(): void
    {
        parent::setUp();
-       $this->bootClearsSchemaCache();
+       $this->bootRefreshesSchemaCache();
     }
}
```

--------------------------------

### Define input types for mutations

Source: https://github.com/nuwave/lighthouse/blob/master/docs/tutorial/README.md

Defines CreatePostInput, CreateUserBelongsTo, UpdatePostInput, and UpdateUserBelongsTo inputs. The author field connects the post to an existing user via nested mutation.

```graphql
input CreatePostInput {
  title: String!
  content: String!
  author: CreateUserBelongsTo!
}

input CreateUserBelongsTo {
  connect: ID!
}

input UpdatePostInput {
  id: ID!
  title: String
  content: String
  author: UpdateUserBelongsTo
}

input UpdateUserBelongsTo {
  connect: ID!
}
```

--------------------------------

### Define upsertUser with identifyingColumns

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/eloquent/getting-started.md

Defines a GraphQL mutation using @upsert with identifyingColumns to identify records by custom fields. All configured identifying columns must be provided with non-null values, otherwise the upsert fails with a GraphQL error.

```graphql
type Mutation {
  upsertUser(name: String!, email: String!): User!
    @upsert(identifyingColumns: ["email"])
}
```

--------------------------------

### Simplify wrapping resolvers in FieldMiddleware directives

Source: https://github.com/nuwave/lighthouse/blob/master/UPGRADE.md

Wrapping resolvers in FieldMiddleware directives is simplified. Instead of manually getting and setting the resolver, use the new wrapResolver() method and change handleField() to return void.

```diff
use Nuwave\Lighthouse\Execution\ResolveInfo;
use Nuwave\Lighthouse\Schema\Values\FieldValue;
use Nuwave\Lighthouse\Support\Contracts\FieldMiddleware;
use Nuwave\Lighthouse\Support\Contracts\GraphQLContext;

final class MyDirective extends BaseDirective implements FieldMiddleware
{
-   public function handleField(FieldValue $fieldValue, \Closure $next): FieldValue
-   {
-       $previousResolver = $fieldValue->getResolver();
-       $fieldValue->setResolver(function (mixed $root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) use ($previousResolver) {
-           return $previousResolver($root, $args, $context, $resolveInfo);
-       });
-       return $next($fieldValue);
+   public function handleField(FieldValue $fieldValue): void
+   {
+       $fieldValue->wrapResolver(fn (callable $previousResolver) => function (mixed $root, array $args, GraphQLContext $context, ResolveInfo $resolveInfo) use ($previousResolver) {
+           return $previousResolver($root, $args, $context, $resolveInfo);
+       });
    }
}
```

--------------------------------

### Directory structure for wildcard imports

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/digging-deeper/schema-organisation.md

Shows a directory layout with a blog subdirectory containing post.graphql and category.graphql.

```text
graphql/
  |-- schema.graphql
  |-- blog/
    |-- post.graphql
    |-- category.graphql
```

--------------------------------

### @morphTo usage example

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/api-reference/directives.md

Example schema using @morphTo on an Image type's imageable field, with a union Imageable.

```graphql
type Image {
  imageable: Imageable! @morphTo
}

union Imageable = Post | User
```

--------------------------------

### Simulate file upload with multipartGraphQL()

Source: https://github.com/nuwave/lighthouse/blob/master/docs/6/testing/phpunit.md

Use the `multipartGraphQL` helper to simulate file uploads through GraphQL, since multipart form requests are tricky to construct. The example shows operations, a map, and a fake uploaded file.

```php
$operations = [
    'query' => /** @lang GraphQL */ <<<'GRAPHQL'
        mutation ($file: Upload!) {
            upload(file: $file)
        }
    GRAPHQL,
    'variables' => [
        'file' => null,
    ],
];

$map = [
    '0' => ['variables.file'],
];

$file = [
    '0' => UploadedFile::fake()->create('test.pdf', 500),
];

$this->multipartGraphQL($operations, $map, $file);
```
Tokens:
Raw