Skip to content
Switch branches/tags

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


A collection of custom scalar types for usage with

Continuous Integration codecov StyleCI

GitHub license Packagist Packagist


composer require mll-lab/graphql-php-scalars


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


A RFC 5321 compliant email.


Arbitrary data encoded in JavaScript Object Notation. See


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.


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 and you will receive a ready-to-use custom regex scalar.

use MLL\GraphQLScalars\Regex;

$hexValue = Regex::make(
    '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.',

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.
     * @var string
    public $description = <<<'DESCRIPTION'
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.

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


The StringScalar encapsulates all the boilerplate associated with creating a string-based Scalar type. It does the proper string checking for you and let's you 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(
    'A name that is most definitely cool.',
    static function (string $name): bool {
        return in_array($name, [

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