1. class
  2. SilverStripe
  3. \
  4. ORM
  5. \
  6. Queries
  7. \
  8. SQLExpression

SQLExpression

abstract class SQLExpression (View source)

Abstract base class for an object representing an SQL query.

The various parts of the SQL query can be manipulated individually.

Properties

protected array $replacementsOld

Keep an internal register of find/replace pairs to execute when it's time to actually get the query SQL.
protected array $replacementsNew

Keep an internal register of find/replace pairs to execute when it's time to actually get the query SQL.

Methods

public
replaceText(string $old, string $new)

Swap some text in the SQL query with another.

public
string
__toString()

Return the generated SQL string for this query

public
renameTable(string $old, string $new)

Swap the use of one table with another.

public
bool
isEmpty()

Determine if this query is empty, and thus cannot be executed

public
string
sql(array $parameters = [])

Generate the SQL statement for this query.

public
Query
execute()

Execute this query.

protected
copyTo(SQLExpression $object)

Copies the query parameters contained in this object to another SQLExpression

Details

at line 39
replaceText(string $old, string $new)

Swap some text in the SQL query with another.

Note that values in parameters will not be replaced

Parameters

string $old

The old text (escaped)
string $new

The new text (escaped)

at line 52
string __toString()

Return the generated SQL string for this query

Is it ok for this to consider parameters? Test cases here!

Return Value

string

at line 71
renameTable(string $old, string $new)

Swap the use of one table with another.

Parameters

string $old

Name of the old table (unquoted, escaped)
string $new

Name of the new table (unquoted, escaped)

at line 83
abstract bool isEmpty()

Determine if this query is empty, and thus cannot be executed

Return Value

bool

Flag indicating that this query is empty

at line 91
string sql(array $parameters = [])

Generate the SQL statement for this query.

Parameters

array $parameters

Out variable for parameters required for this query

Return Value

string

The completed SQL query

at line 112
Query execute()

Execute this query.

Return Value

Query

at line 124
protected copyTo(SQLExpression $object)

Copies the query parameters contained in this object to another SQLExpression

Parameters

SQLExpression $object

The object to copy properties to