thecodingmachine/graphqlite

Write your GraphQL queries in simple to write controllers (using webonyx/graphql-php).

v8.0.0 2024-12-18 06:52 UTC

Requires

• php: >=8.1
• ext-json: *
• composer/package-versions-deprecated: ^1.8
• kcs/class-finder: ^0.6.0
• phpdocumentor/reflection-docblock: ^4.3 || ^5.0
• phpdocumentor/type-resolver: ^1.4
• psr/container: ^1.1 || ^2
• psr/http-factory: ^1
• psr/http-message: ^1.0.1 || ^2.0
• psr/http-server-handler: ^1
• psr/http-server-middleware: ^1
• psr/simple-cache: ^1.0.1 || ^2 || ^3
• symfony/cache: ^4.3 || ^5 || ^6 || ^7
• symfony/expression-language: ^4 || ^5 || ^6 || ^7
• webonyx/graphql-php: ^v15.0

Requires (Dev)

• beberlei/porpaginas: ^1.2 || ^2.0
• doctrine/coding-standard: ^11.0 || ^12.0
• ecodev/graphql-upload: ^7.0
• laminas/laminas-diactoros: ^2 || ^3
• myclabs/php-enum: ^1.6.6
• php-coveralls/php-coveralls: ^2.1
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.11
• phpunit/phpunit: ^10.1 || ^11.0
• symfony/var-dumper: ^5.4 || ^6.0 || ^7
• thecodingmachine/phpstan-strict-rules: ^1.0

Suggests

• beberlei/porpaginas: If you want automatic pagination in your GraphQL types
• ecodev/graphql-upload: If you want to support file upload inside GraphQL input types

MIT

• David Négrier

README

GraphQLite

GraphQL in PHP made easy.

Documentation · Contributing

A GraphQL library for PHP that allows you to use attributes (or annotations) to define your schema and write your queries and mutations using simple-to-write controllers.

Features

• Create a complete GraphQL API by simply annotating your PHP classes
• Framework agnostic, but with Symfony and Laravel integrations available!
• Comes with batteries included 🔋: queries, mutations, subscriptions, mapping of arrays/iterators, file uploads, extendable types and more!

Basic example

First, declare a mutation in your controller:

class ProductController
{
    #[Mutation]
    public function updateProduct(Product $product): Product
    {
        // Some code that gets and updates a Product
        return $product;
    }
}

Then, annotate the Product class to declare what fields are exposed to the GraphQL API:

#[Type]
#[Input(update: true)]
class Product
{
    #[Field]
    public function getName(): string
    {
        return $this->name;
    }
    
    #[Field]
    public function setName(string $name): void
    {
        $this->name = $name;
    }
    
    // ...
}

That's it, you're good to go 🎉 mutate away!

{
  updateProduct(product: {
    name: 'John Doe'
  }) {
    name
  }
}

Want to learn more? Head to the documentation!

Contributing

Contributions are welcomed via pull requests. If you'd like to discuss prior to submitting a PR, consider a discussion. If it's a bug/issue, you can submit an issue first.

All PRs should have sufficient test coverage for any additions or changes. PRs will not be merged without these.