Automattic\WooCommerce\Vendor\GraphQL\Validator\Rules

NoUnusedFragments{} │ WC 1.0└─ ValidationRule

No Hooks.

Usage

$NoUnusedFragments = new NoUnusedFragments();
// use class methods

Methods

1. public getVisitor(QueryValidationContext $context)
2. public static unusedFragMessage(string $fragName)

NoUnusedFragments{} NoUnusedFragments{} code ^{WC 10.9.1}

class NoUnusedFragments extends ValidationRule
{
    /** @var array<int, OperationDefinitionNode> */
    protected array $operationDefs;

    /** @var array<int, FragmentDefinitionNode> */
    protected array $fragmentDefs;

    public function getVisitor(QueryValidationContext $context): array
    {
        $this->operationDefs = [];
        $this->fragmentDefs = [];

        return [
            NodeKind::OPERATION_DEFINITION => function ($node): VisitorOperation {
                $this->operationDefs[] = $node;

                return Visitor::skipNode();
            },
            NodeKind::FRAGMENT_DEFINITION => function (FragmentDefinitionNode $def): VisitorOperation {
                $this->fragmentDefs[] = $def;

                return Visitor::skipNode();
            },
            NodeKind::DOCUMENT => [
                'leave' => function () use ($context): void {
                    $fragmentNameUsed = [];

                    foreach ($this->operationDefs as $operation) {
                        foreach ($context->getRecursivelyReferencedFragments($operation) as $fragment) {
                            $fragmentNameUsed[$fragment->name->value] = true;
                        }
                    }

                    foreach ($this->fragmentDefs as $fragmentDef) {
                        $fragName = $fragmentDef->name->value;

                        if (! isset($fragmentNameUsed[$fragName])) {
                            $context->reportError(new Error(
                                static::unusedFragMessage($fragName),
                                [$fragmentDef]
                            ));
                        }
                    }
                },
            ],
        ];
    }

    public static function unusedFragMessage(string $fragName): string
    {
        return "Fragment \"{$fragName}\" is never used.";
    }
}