graphql-php-scalars

A collection of custom scalar types for usage with https://github.com/webonyx/graphql-php

Installation

composer require mll-lab/graphql-php-scalars

Usage

You can use the provided Scalars just like any other type in your schema definition. Check SchemaUsageTest for an example.

BigInt

An arbitrarily long sequence of digits that represents a big integer.

Date

A date string with format Y-m-d, e.g. 2011-05-23.

The following conversion applies to all date scalars:

• Outgoing values can either be valid date strings or \DateTimeInterface instances.
• Incoming values must always be valid date strings and will be converted to \DateTimeImmutable instances.

DateTime

A datetime string with format Y-m-d H:i:s, e.g. 2018-05-23 13:43:32.

DateTimeTz

A datetime string with format Y-m-d\TH:i:s.uP, e.g. 2020-04-20T16:20:04+04:00, 2020-04-20T16:20:04Z.

Email

A RFC 5321 compliant email.

IntRange

Allows defining numeric scalars where the values must lie between a defined minimum and maximum.

use MLL\GraphQLScalars\IntRange;

final class UpToADozen extends IntRange
{
    protected static function min(): int
    {
        return 1;
    }

    protected static function max(): int
    {
        return 12;
    }
}

JSON

Arbitrary data encoded in JavaScript Object Notation. See https://www.json.org.

This expects a string in JSON format, not an arbitrary JSON value or GraphQL literal.

type Query {
  foo(bar: JSON!): JSON!
}

# Wrong, the given value is a GraphQL literal object
{
  foo(bar: { baz: 2 })
}

# Correct, the given value is a JSON string representing an object
{
  foo(bar: "{ \"bar\": 2 }")
}

// Wrong, the variable value is a JSON object
{
  "query": "query ($bar: JSON!) { foo(bar: $bar) }",
  "variables": {
    "bar": {
      "baz": 2
    }
  }
}

// Correct, the variable value is a JSON string representing an object
{
  "query": "query ($bar: JSON!) { foo(bar: $bar) }",
  "variables": {
    "bar": "{ \"bar\": 2 }"
  }
}

JSON responses will contain nested JSON strings.

{
  "data": {
    "foo": "{ \"bar\": 2 }"
  }
}

Mixed

Loose type that allows any value. Be careful when passing in large Int or Float literals, as they may not be parsed correctly on the server side. Use String literals if you are dealing with really large numbers to be on the safe side.

Null

Always null. Strictly validates value is non-null, no coercion.

Regex

The Regex class allows you to define a custom scalar that validates that the given value matches a regular expression.

The quickest way to define a custom scalar is the make factory method. Just provide a name and a regular expression, you will receive a ready-to-use custom regex scalar.

use MLL\GraphQLScalars\Regex;

$hexValue = Regex::make(
    'HexValue',
    'A hexadecimal color is specified with: `#RRGGBB`, where `RR` (red), `GG` (green) and `BB` (blue) are hexadecimal integers between `00` and `FF` specifying the intensity of the color.',
    '/^#?([a-f0-9]{6}|[a-f0-9]{3})$/'
);

You may also define your regex scalar as a class.

use MLL\GraphQLScalars\Regex;

// The name is implicitly set through the class name here
class HexValue extends Regex
{
    /** The description that is used for schema introspection. */
    public ?string $description = /** @lang Markdown */<<<'MARKDOWN'
    A hexadecimal color is specified with: `#RRGGBB`, where `RR` (red), `GG` (green) and `BB` (blue)
    are hexadecimal integers between `00` and `FF` specifying the intensity of the color.
    MARKDOWN;

    public static function regex(): string
    {
        return '/^#?([a-f0-9]{6}|[a-f0-9]{3})$/';
    }
}

StringScalar

The StringScalar encapsulates all the boilerplate associated with creating a string-based Scalar type. It performs basic checks and coercion, you can focus on the minimal logic that is specific to your use case.

All you have to specify is a function that checks if the given string is valid. Use the factory method make to generate an instance on the fly.

use MLL\GraphQLScalars\StringScalar;

$coolName = StringScalar::make(
    'CoolName',
    'A name that is most definitely cool.',
    static fn (string $name): bool => in_array($name, [
       'Vladar',
       'Benedikt',
       'Christopher',
    ]),
);

Or you may simply extend the class, check out the implementation of the Email scalar to see how.