class SQLFormatter (View source)

Format a SQL Query for better readable output in HTML or Plaintext.

Its a simple string parser, not a full tokenizer - so formatting is not aware of the SQL syntax. This means we have to be conservative with modifying the SQL string.

Traits

A class that can be instantiated or replaced via DI

Properties

protected static $newline_before_tokens

Methods

public static 
create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

public static 
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

public
formatPlain($sql)

No description

public
formatHTML($sql)

No description

protected
string
addNewlines(string $sql, bool $useHtmlFormatting = false)

Newlines for tokens defined in $newline_before_tokens.

Details

static Injectable create(mixed ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

mixed ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

formatPlain($sql)

No description

Parameters

$sql

formatHTML($sql)

No description

Parameters

$sql

protected string addNewlines(string $sql, bool $useHtmlFormatting = false)

Newlines for tokens defined in $newline_before_tokens.

Case-sensitive, only applies to uppercase SQL to avoid messing with possible content fragments in the query.

Parameters

string $sql
bool $useHtmlFormatting

Return Value

string