PHP Class SqlParser\Utils\Formatter

Public Properties

Property	Type	Description
$INLINE_CLAUSES	array	These clauses usually are short and it's nicer to have them inline.
$options	array	The formatting options.

Method	Description
__construct ( array $options = [] )	Constructor.
escapeConsole ( $string )
format ( string $query, array $options = [] ) : string	Formats a query.
formatList ( TokensList $list ) : string	Formats the given list of tokens.
getGroupLength ( TokensList $list ) : integer	Computes the length of a group.
isClause ( Token $token ) : integer \| boolean	Checks if a token is a statement or a clause inside a statement.
toString ( Token $token ) : string	Tries to print the query and returns the result.

Constructor.

public __construct ( array $options = [] )
$options	array	The formatting options.

public escapeConsole ( $string )

Formats a query.

public static format ( string $query, array $options = [] ) : string
$query	string	The query to be formatted
$options	array	The formatting options.
return	string	The formatted string.

Formats the given list of tokens.

public formatList ( TokensList $list ) : string
$list	SqlParser\TokensList	The list of tokens.
return	string

A group is delimited by a pair of brackets.

public static getGroupLength ( TokensList $list ) : integer
$list	SqlParser\TokensList	The list of tokens.
return	integer

Checks if a token is a statement or a clause inside a statement.

public static isClause ( Token $token ) : integer \| boolean
$token	SqlParser\Token	The token to be checked.
return	integer \| boolean

Tries to print the query and returns the result.

public toString ( Token $token ) : string
$token	SqlParser\Token	The token to be printed.
return	string

These clauses usually are short and it's nicer to have them inline.

public static array $INLINE_CLAUSES
return	array

The formatting options.

public array $options
return	array