function Connection::defaultOptions

Returns the default query options for any given query.

A given query can be customized with a number of option flags in an associative array:

• fetch: This element controls how rows from a result set will be returned. Legal values include \PDO::FETCH_ASSOC, \PDO::FETCH_BOTH, \PDO::FETCH_OBJ, \PDO::FETCH_NUM, or a string representing the name of a class. If a string is specified, each record will be fetched into a new object of that class. The behavior of all other values is defined by PDO. See http://php.net/manual/pdostatement.fetch.php
• allow_delimiter_in_query: By default, queries which have the ; delimiter any place in them will cause an exception. This reduces the chance of SQL injection attacks that terminate the original query and add one or more additional queries (such as inserting new user accounts). In rare cases, such as creating an SQL function, a ; is needed and can be allowed by changing this option to TRUE.
• allow_square_brackets: By default, queries which contain square brackets will have them replaced with the identifier quote character for the database type. In rare cases, such as creating an SQL function, [] characters might be needed and can be allowed by changing this option to TRUE.
• pdo: By default, queries will execute with the client connection options set on the connection. In particular cases, it could be necessary to override the driver options on the statement level. In such case, pass the required setting as an array here, and they will be passed to the prepared statement.

Return value

array An array of default query options.

File

core/lib/Drupal/Core/Database/Connection.php, line 278

Class

Connection

Base Database API class.

Namespace

Code

protected function defaultOptions() {
    return [
        'fetch' => \PDO::FETCH_OBJ,
        'allow_delimiter_in_query' => FALSE,
        'allow_square_brackets' => FALSE,
        'pdo' => [],
    ];
}