Documentation

Printer
in package

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:

$query = 'query myQuery {someField}';
$ast = GraphQL\Language\Parser::parse($query);
$printed = GraphQL\Language\Printer::doPrint($ast);

Table of Contents

addDescription()  : mixed
block()  : mixed
Given array, print each item on its own line, wrapped in an indented "{ }" block.
doPrint()  : string
Prints AST to string. Capable of printing GraphQL queries and Type definition language.
indent()  : mixed
join()  : string
length()  : mixed
manyList()  : mixed
printAST()  : mixed
Traverse an AST bottom-up, converting all nodes to strings.
wrap()  : mixed
If maybeString is not null or empty, then wrap with start and end, otherwise print an empty string.
__construct()  : mixed
printBlockString()  : mixed
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.

Methods

addDescription()

public addDescription(callable $cb) : mixed
Parameters
$cb : callable
Return values
mixed —

block()

Given array, print each item on its own line, wrapped in an indented "{ }" block.

public block(mixed $array) : mixed
Parameters
$array : mixed
Return values
mixed —

doPrint()

Prints AST to string. Capable of printing GraphQL queries and Type definition language.

public static doPrint(Node $ast) : string
Parameters
$ast : Node
Return values
string —

indent()

public indent(mixed $maybeString) : mixed
Parameters
$maybeString : mixed
Return values
mixed —

join()

public join(mixed $maybeArray[, mixed $separator = '' ]) : string
Parameters
$maybeArray : mixed
$separator : mixed = ''
Return values
string —

length()

public length(mixed $maybeArray) : mixed
Parameters
$maybeArray : mixed
Return values
mixed —

manyList()

public manyList(mixed $start, mixed $list, mixed $separator, mixed $end) : mixed
Parameters
$start : mixed
$list : mixed
$separator : mixed
$end : mixed
Return values
mixed —

printAST()

Traverse an AST bottom-up, converting all nodes to strings.

public printAST(mixed $ast) : mixed

That means the AST is manipulated in such a way that it no longer resembles the well-formed result of parsing.

Parameters
$ast : mixed
Return values
mixed —

wrap()

If maybeString is not null or empty, then wrap with start and end, otherwise print an empty string.

public wrap(mixed $start, mixed $maybeString[, mixed $end = '' ]) : mixed
Parameters
$start : mixed
$maybeString : mixed
$end : mixed = ''
Return values
mixed —

__construct()

protected __construct() : mixed
Return values
mixed —

printBlockString()

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 printBlockString(mixed $value, mixed $isDescription) : mixed
Parameters
$value : mixed
$isDescription : mixed
Return values
mixed —

Search results