Your Name
540 lines
22 KiB
PHP
540 lines
22 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace GraphQL\Language;
|
|
|
|
use GraphQL\Language\AST\ArgumentNode;
|
|
use GraphQL\Language\AST\BooleanValueNode;
|
|
use GraphQL\Language\AST\DirectiveDefinitionNode;
|
|
use GraphQL\Language\AST\DirectiveNode;
|
|
use GraphQL\Language\AST\DocumentNode;
|
|
use GraphQL\Language\AST\EnumTypeDefinitionNode;
|
|
use GraphQL\Language\AST\EnumTypeExtensionNode;
|
|
use GraphQL\Language\AST\EnumValueDefinitionNode;
|
|
use GraphQL\Language\AST\EnumValueNode;
|
|
use GraphQL\Language\AST\FieldDefinitionNode;
|
|
use GraphQL\Language\AST\FieldNode;
|
|
use GraphQL\Language\AST\FloatValueNode;
|
|
use GraphQL\Language\AST\FragmentDefinitionNode;
|
|
use GraphQL\Language\AST\FragmentSpreadNode;
|
|
use GraphQL\Language\AST\InlineFragmentNode;
|
|
use GraphQL\Language\AST\InputObjectTypeDefinitionNode;
|
|
use GraphQL\Language\AST\InputObjectTypeExtensionNode;
|
|
use GraphQL\Language\AST\InputValueDefinitionNode;
|
|
use GraphQL\Language\AST\InterfaceTypeDefinitionNode;
|
|
use GraphQL\Language\AST\InterfaceTypeExtensionNode;
|
|
use GraphQL\Language\AST\IntValueNode;
|
|
use GraphQL\Language\AST\ListTypeNode;
|
|
use GraphQL\Language\AST\ListValueNode;
|
|
use GraphQL\Language\AST\NamedTypeNode;
|
|
use GraphQL\Language\AST\NameNode;
|
|
use GraphQL\Language\AST\Node;
|
|
use GraphQL\Language\AST\NodeKind;
|
|
use GraphQL\Language\AST\NonNullTypeNode;
|
|
use GraphQL\Language\AST\NullValueNode;
|
|
use GraphQL\Language\AST\ObjectFieldNode;
|
|
use GraphQL\Language\AST\ObjectTypeDefinitionNode;
|
|
use GraphQL\Language\AST\ObjectTypeExtensionNode;
|
|
use GraphQL\Language\AST\ObjectValueNode;
|
|
use GraphQL\Language\AST\OperationDefinitionNode;
|
|
use GraphQL\Language\AST\OperationTypeDefinitionNode;
|
|
use GraphQL\Language\AST\ScalarTypeDefinitionNode;
|
|
use GraphQL\Language\AST\ScalarTypeExtensionNode;
|
|
use GraphQL\Language\AST\SchemaDefinitionNode;
|
|
use GraphQL\Language\AST\SchemaTypeExtensionNode;
|
|
use GraphQL\Language\AST\SelectionSetNode;
|
|
use GraphQL\Language\AST\StringValueNode;
|
|
use GraphQL\Language\AST\UnionTypeDefinitionNode;
|
|
use GraphQL\Language\AST\UnionTypeExtensionNode;
|
|
use GraphQL\Language\AST\VariableDefinitionNode;
|
|
use GraphQL\Language\AST\VariableNode;
|
|
use GraphQL\Utils\Utils;
|
|
use function count;
|
|
use function implode;
|
|
use function json_encode;
|
|
use function preg_replace;
|
|
use function sprintf;
|
|
use function str_replace;
|
|
use function strlen;
|
|
use function strpos;
|
|
|
|
/**
|
|
* Prints AST to string. Capable of printing GraphQL queries and Type definition language.
|
|
* Useful for pretty-printing queries or printing back AST for logging, documentation, etc.
|
|
*
|
|
* Usage example:
|
|
*
|
|
* ```php
|
|
* $query = 'query myQuery {someField}';
|
|
* $ast = GraphQL\Language\Parser::parse($query);
|
|
* $printed = GraphQL\Language\Printer::doPrint($ast);
|
|
* ```
|
|
*/
|
|
class Printer
|
|
{
|
|
/**
|
|
* Prints AST to string. Capable of printing GraphQL queries and Type definition language.
|
|
*
|
|
* @param Node $ast
|
|
*
|
|
* @return string
|
|
*
|
|
* @api
|
|
*/
|
|
public static function doPrint($ast)
|
|
{
|
|
static $instance;
|
|
$instance = $instance ?? new static();
|
|
|
|
return $instance->printAST($ast);
|
|
}
|
|
|
|
protected function __construct()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Traverse an AST bottom-up, converting all nodes to strings.
|
|
*
|
|
* That means the AST is manipulated in such a way that it no longer
|
|
* resembles the well-formed result of parsing.
|
|
*/
|
|
public function printAST($ast)
|
|
{
|
|
return Visitor::visit(
|
|
$ast,
|
|
[
|
|
'leave' => [
|
|
NodeKind::NAME => static function (NameNode $node) : string {
|
|
return $node->value;
|
|
},
|
|
|
|
NodeKind::VARIABLE => static function (VariableNode $node) : string {
|
|
return '$' . $node->name;
|
|
},
|
|
|
|
NodeKind::DOCUMENT => function (DocumentNode $node) : string {
|
|
return $this->join($node->definitions, "\n\n") . "\n";
|
|
},
|
|
|
|
NodeKind::OPERATION_DEFINITION => function (OperationDefinitionNode $node) : string {
|
|
$op = $node->operation;
|
|
$name = $node->name;
|
|
$varDefs = $this->wrap('(', $this->join($node->variableDefinitions, ', '), ')');
|
|
$directives = $this->join($node->directives, ' ');
|
|
$selectionSet = $node->selectionSet;
|
|
|
|
// Anonymous queries with no directives or variable definitions can use
|
|
// the query short form.
|
|
return $name === null && strlen($directives ?? '') === 0 && ! $varDefs && $op === 'query'
|
|
? $selectionSet
|
|
: $this->join([$op, $this->join([$name, $varDefs]), $directives, $selectionSet], ' ');
|
|
},
|
|
|
|
NodeKind::VARIABLE_DEFINITION => function (VariableDefinitionNode $node) : string {
|
|
return $node->variable
|
|
. ': '
|
|
. $node->type
|
|
. $this->wrap(' = ', $node->defaultValue)
|
|
. $this->wrap(' ', $this->join($node->directives, ' '));
|
|
},
|
|
|
|
NodeKind::SELECTION_SET => function (SelectionSetNode $node) {
|
|
return $this->block($node->selections);
|
|
},
|
|
|
|
NodeKind::FIELD => function (FieldNode $node) : string {
|
|
return $this->join(
|
|
[
|
|
$this->wrap('', $node->alias, ': ') . $node->name . $this->wrap(
|
|
'(',
|
|
$this->join($node->arguments, ', '),
|
|
')'
|
|
),
|
|
$this->join($node->directives, ' '),
|
|
$node->selectionSet,
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::ARGUMENT => static function (ArgumentNode $node) : string {
|
|
return $node->name . ': ' . $node->value;
|
|
},
|
|
|
|
NodeKind::FRAGMENT_SPREAD => function (FragmentSpreadNode $node) : string {
|
|
return '...'
|
|
. $node->name
|
|
. $this->wrap(' ', $this->join($node->directives, ' '));
|
|
},
|
|
|
|
NodeKind::INLINE_FRAGMENT => function (InlineFragmentNode $node) : string {
|
|
return $this->join(
|
|
[
|
|
'...',
|
|
$this->wrap('on ', $node->typeCondition),
|
|
$this->join($node->directives, ' '),
|
|
$node->selectionSet,
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::FRAGMENT_DEFINITION => function (FragmentDefinitionNode $node) : string {
|
|
// Note: fragment variable definitions are experimental and may be changed or removed in the future.
|
|
return sprintf('fragment %s', $node->name)
|
|
. $this->wrap('(', $this->join($node->variableDefinitions, ', '), ')')
|
|
. sprintf(' on %s ', $node->typeCondition)
|
|
. $this->wrap('', $this->join($node->directives, ' '), ' ')
|
|
. $node->selectionSet;
|
|
},
|
|
|
|
NodeKind::INT => static function (IntValueNode $node) : string {
|
|
return $node->value;
|
|
},
|
|
|
|
NodeKind::FLOAT => static function (FloatValueNode $node) : string {
|
|
return $node->value;
|
|
},
|
|
|
|
NodeKind::STRING => function (StringValueNode $node, $key) : string {
|
|
if ($node->block) {
|
|
return $this->printBlockString($node->value, $key === 'description');
|
|
}
|
|
|
|
return json_encode($node->value);
|
|
},
|
|
|
|
NodeKind::BOOLEAN => static function (BooleanValueNode $node) : string {
|
|
return $node->value ? 'true' : 'false';
|
|
},
|
|
|
|
NodeKind::NULL => static function (NullValueNode $node) : string {
|
|
return 'null';
|
|
},
|
|
|
|
NodeKind::ENUM => static function (EnumValueNode $node) : string {
|
|
return $node->value;
|
|
},
|
|
|
|
NodeKind::LST => function (ListValueNode $node) : string {
|
|
return '[' . $this->join($node->values, ', ') . ']';
|
|
},
|
|
|
|
NodeKind::OBJECT => function (ObjectValueNode $node) : string {
|
|
return '{' . $this->join($node->fields, ', ') . '}';
|
|
},
|
|
|
|
NodeKind::OBJECT_FIELD => static function (ObjectFieldNode $node) : string {
|
|
return $node->name . ': ' . $node->value;
|
|
},
|
|
|
|
NodeKind::DIRECTIVE => function (DirectiveNode $node) : string {
|
|
return '@' . $node->name . $this->wrap('(', $this->join($node->arguments, ', '), ')');
|
|
},
|
|
|
|
NodeKind::NAMED_TYPE => static function (NamedTypeNode $node) : string {
|
|
// @phpstan-ignore-next-line the printer works bottom up, so this is already a string here
|
|
return $node->name;
|
|
},
|
|
|
|
NodeKind::LIST_TYPE => static function (ListTypeNode $node) : string {
|
|
return '[' . $node->type . ']';
|
|
},
|
|
|
|
NodeKind::NON_NULL_TYPE => static function (NonNullTypeNode $node) : string {
|
|
return $node->type . '!';
|
|
},
|
|
|
|
NodeKind::SCHEMA_DEFINITION => function (SchemaDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'schema',
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->operationTypes),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::OPERATION_TYPE_DEFINITION => static function (OperationTypeDefinitionNode $def) : string {
|
|
return $def->operation . ': ' . $def->type;
|
|
},
|
|
|
|
NodeKind::SCALAR_TYPE_DEFINITION => $this->addDescription(function (ScalarTypeDefinitionNode $def) : string {
|
|
return $this->join(['scalar', $def->name, $this->join($def->directives, ' ')], ' ');
|
|
}),
|
|
|
|
NodeKind::OBJECT_TYPE_DEFINITION => $this->addDescription(function (ObjectTypeDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'type',
|
|
$def->name,
|
|
$this->wrap('implements ', $this->join($def->interfaces, ' & ')),
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
}),
|
|
|
|
NodeKind::FIELD_DEFINITION => $this->addDescription(function (FieldDefinitionNode $def) : string {
|
|
$noIndent = Utils::every($def->arguments, static function (string $arg) : bool {
|
|
return strpos($arg, "\n") === false;
|
|
});
|
|
|
|
return $def->name
|
|
. ($noIndent
|
|
? $this->wrap('(', $this->join($def->arguments, ', '), ')')
|
|
: $this->wrap("(\n", $this->indent($this->join($def->arguments, "\n")), "\n)"))
|
|
. ': ' . $def->type
|
|
. $this->wrap(' ', $this->join($def->directives, ' '));
|
|
}),
|
|
|
|
NodeKind::INPUT_VALUE_DEFINITION => $this->addDescription(function (InputValueDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
$def->name . ': ' . $def->type,
|
|
$this->wrap('= ', $def->defaultValue),
|
|
$this->join($def->directives, ' '),
|
|
],
|
|
' '
|
|
);
|
|
}),
|
|
|
|
NodeKind::INTERFACE_TYPE_DEFINITION => $this->addDescription(
|
|
function (InterfaceTypeDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'interface',
|
|
$def->name,
|
|
$this->wrap('implements ', $this->join($def->interfaces, ' & ')),
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
}
|
|
),
|
|
|
|
NodeKind::UNION_TYPE_DEFINITION => $this->addDescription(function (UnionTypeDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'union',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
count($def->types ?? []) > 0
|
|
? '= ' . $this->join($def->types, ' | ')
|
|
: '',
|
|
],
|
|
' '
|
|
);
|
|
}),
|
|
|
|
NodeKind::ENUM_TYPE_DEFINITION => $this->addDescription(function (EnumTypeDefinitionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'enum',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->values),
|
|
],
|
|
' '
|
|
);
|
|
}),
|
|
|
|
NodeKind::ENUM_VALUE_DEFINITION => $this->addDescription(function (EnumValueDefinitionNode $def) : string {
|
|
return $this->join([$def->name, $this->join($def->directives, ' ')], ' ');
|
|
}),
|
|
|
|
NodeKind::INPUT_OBJECT_TYPE_DEFINITION => $this->addDescription(function (
|
|
InputObjectTypeDefinitionNode $def
|
|
) : string {
|
|
return $this->join(
|
|
[
|
|
'input',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
}),
|
|
|
|
NodeKind::SCHEMA_EXTENSION => function (SchemaTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend schema',
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->operationTypes),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::SCALAR_TYPE_EXTENSION => function (ScalarTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend scalar',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::OBJECT_TYPE_EXTENSION => function (ObjectTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend type',
|
|
$def->name,
|
|
$this->wrap('implements ', $this->join($def->interfaces, ' & ')),
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::INTERFACE_TYPE_EXTENSION => function (InterfaceTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend interface',
|
|
$def->name,
|
|
$this->wrap('implements ', $this->join($def->interfaces, ' & ')),
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::UNION_TYPE_EXTENSION => function (UnionTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend union',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
count($def->types ?? []) > 0
|
|
? '= ' . $this->join($def->types, ' | ')
|
|
: '',
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::ENUM_TYPE_EXTENSION => function (EnumTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend enum',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->values),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::INPUT_OBJECT_TYPE_EXTENSION => function (InputObjectTypeExtensionNode $def) : string {
|
|
return $this->join(
|
|
[
|
|
'extend input',
|
|
$def->name,
|
|
$this->join($def->directives, ' '),
|
|
$this->block($def->fields),
|
|
],
|
|
' '
|
|
);
|
|
},
|
|
|
|
NodeKind::DIRECTIVE_DEFINITION => $this->addDescription(function (DirectiveDefinitionNode $def) : string {
|
|
$noIndent = Utils::every($def->arguments, static function (string $arg) : bool {
|
|
return strpos($arg, "\n") === false;
|
|
});
|
|
|
|
return 'directive @'
|
|
. $def->name
|
|
. ($noIndent
|
|
? $this->wrap('(', $this->join($def->arguments, ', '), ')')
|
|
: $this->wrap("(\n", $this->indent($this->join($def->arguments, "\n")), "\n"))
|
|
. ($def->repeatable ? ' repeatable' : '')
|
|
. ' on ' . $this->join($def->locations, ' | ');
|
|
}),
|
|
],
|
|
]
|
|
);
|
|
}
|
|
|
|
public function addDescription(callable $cb)
|
|
{
|
|
return function ($node) use ($cb) : string {
|
|
return $this->join([$node->description, $cb($node)], "\n");
|
|
};
|
|
}
|
|
|
|
/**
|
|
* If maybeString is not null or empty, then wrap with start and end, otherwise
|
|
* print an empty string.
|
|
*/
|
|
public function wrap($start, $maybeString, $end = '')
|
|
{
|
|
return $maybeString ? ($start . $maybeString . $end) : '';
|
|
}
|
|
|
|
/**
|
|
* Given array, print each item on its own line, wrapped in an
|
|
* indented "{ }" block.
|
|
*/
|
|
public function block($array)
|
|
{
|
|
return $array && $this->length($array)
|
|
? "{\n" . $this->indent($this->join($array, "\n")) . "\n}"
|
|
: '';
|
|
}
|
|
|
|
public function indent($maybeString)
|
|
{
|
|
return $maybeString ? ' ' . str_replace("\n", "\n ", $maybeString) : '';
|
|
}
|
|
|
|
public function manyList($start, $list, $separator, $end)
|
|
{
|
|
return $this->length($list) === 0 ? null : ($start . $this->join($list, $separator) . $end);
|
|
}
|
|
|
|
public function length($maybeArray)
|
|
{
|
|
return $maybeArray ? count($maybeArray) : 0;
|
|
}
|
|
|
|
public function join($maybeArray, $separator = '') : string
|
|
{
|
|
return $maybeArray
|
|
? implode(
|
|
$separator,
|
|
Utils::filter(
|
|
$maybeArray,
|
|
static function ($x) : bool {
|
|
return (bool) $x;
|
|
}
|
|
)
|
|
)
|
|
: '';
|
|
}
|
|
|
|
/**
|
|
* Print a block string in the indented block form by adding a leading and
|
|
* trailing blank line. However, if a block string starts with whitespace and is
|
|
* a single-line, adding a leading blank line would strip that whitespace.
|
|
*/
|
|
private function printBlockString($value, $isDescription)
|
|
{
|
|
$escaped = str_replace('"""', '\\"""', $value);
|
|
|
|
return ($value[0] === ' ' || $value[0] === "\t") && strpos($value, "\n") === false
|
|
? ('"""' . preg_replace('/"$/', "\"\n", $escaped) . '"""')
|
|
: ('"""' . "\n" . ($isDescription ? $escaped : $this->indent($escaped)) . "\n" . '"""');
|
|
}
|
|
}
|