webonyx / graphql-php

src/Validator/Rules/VariablesDefaultValueAllowed.php

<?php

declare(strict_types=1);

namespace GraphQL\Validator\Rules;

use GraphQL\Error\Error;
use GraphQL\Language\AST\FragmentDefinitionNode;
use GraphQL\Language\AST\NodeKind;
use GraphQL\Language\AST\SelectionSetNode;
use GraphQL\Language\AST\VariableDefinitionNode;
use GraphQL\Language\Visitor;
use GraphQL\Type\Definition\NonNull;
use GraphQL\Validator\ValidationContext;
use function sprintf;

/**
 * Variable's default value is allowed
 *
 * A GraphQL document is only valid if all variable default values are allowed
 * due to a variable not being required.
 */
class VariablesDefaultValueAllowed extends ValidationRule
{
    public function getVisitor(ValidationContext $context)
    {
        return [
            NodeKind::VARIABLE_DEFINITION => function (VariableDefinitionNode $node) use ($context) {
                $name         = $node->variable->name->value;
                $defaultValue = $node->defaultValue;
                $type         = $context->getInputType();
                if ($type instanceof NonNull && $defaultValue) {
                    $context->reportError(
                        new Error(
                            self::defaultForRequiredVarMessage(
                                $name,
                                $type,
                                $type->getWrappedType()
                            ),
                            [$defaultValue]
                        )
                    );
                }

                return Visitor::skipNode();
            },
            NodeKind::SELECTION_SET       => function (SelectionSetNode $node) {

The parameter $node is not used and could be removed.

                return Visitor::skipNode();
            },
            NodeKind::FRAGMENT_DEFINITION => function (FragmentDefinitionNode $node) {

The parameter $node is not used and could be removed.

                return Visitor::skipNode();
            },
        ];
    }

    public static function defaultForRequiredVarMessage($varName, $type, $guessType)
    {
        return sprintf(
            'Variable "$%s" of type "%s" is required and will not use the default value. Perhaps you meant to use type "%s".',
            $varName,
            $type,
            $guessType
        );
    }
}