1. class
  2. Windwalker
  3. Database
  4. Driver
  5. Postgresql
  6. PostgresqlDriver

PostgresqlDriver

class PostgresqlDriver extends PdoDriver (View source)

The PostgresqlDriver class.

Methods

__construct(null $connection = null, array $options = array())

Constructor.

resource|object
getConnection()

getConnection

from AbstractDatabaseDriver
AbstractDatabaseDriver
setConnection(resource $connection)

setConnection

from AbstractDatabaseDriver
resource|false
execute()

Execute the SQL statement.

from AbstractDatabaseDriver
AbstractDatabaseDriver
connect()

connect

from PdoDriver
AbstractDatabaseDriver
disconnect()

Disconnects the database.

from PdoDriver
boolean
select(string $database)

Select a database for use.

from PdoDriver
string
getVersion()

Get the version of the database connector

from PdoDriver
AbstractDatabaseDriver
freeResult(mixed $cursor = null)

Method to free up the memory used for the result set.

from PdoDriver
mixed
listDatabases()

getDatabaseList

from PdoDriver
resource
getCursor()

getCursor

from AbstractDatabaseDriver
Query
getQuery(boolean $new = false)

Get the current query object or a new Query object.

from PdoDriver
AbstractTable
getTable(string $name, bool $new = false)

getTable

from AbstractDatabaseDriver
AbstractDatabase
getDatabase(string $name = null, bool $new = false)

getTable

from AbstractDatabaseDriver
AbstractReader
getReader(Query $query = null, bool $new = true)

getReader

from AbstractDatabaseDriver
AbstractWriter
getWriter(bool $new = true)

getWriter

from AbstractDatabaseDriver
AbstractTransaction
getTransaction(boolean $nested = true, bool $new = false)

getWriter

from AbstractDatabaseDriver
DataIterator
getIterator(string $class = 'stdClass')

getIterator

from AbstractDatabaseDriver
string
getCurrentDatabase()

Gets the name of the database used by this conneciton.

from AbstractDatabaseDriver
string
getPrefix()

Get the common table prefix for the database driver.

from AbstractDatabaseDriver
string
replacePrefix(string $sql, string $prefix = '#__')

This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.

static array
splitSql(string $sql)

Splits a string of multiple queries into an array of individual queries.

from AbstractDatabaseDriver
AbstractDatabaseDriver
setDebug(boolean $level)

Sets the database debugging state for the driver.

from AbstractDatabaseDriver
AbstractDatabaseDriver
setQuery(mixed $query, array $driverOptions = array())

Sets the SQL statement string for later execution.

from PdoDriver
mixed
loadAll(string $key = null, string $class = '\\stdClass')

loadAll

from AbstractDatabaseDriver
mixed
loadOne(string $class = '\\stdClass')

loadOne

from AbstractDatabaseDriver
mixed
loadResult()

loadResult

from AbstractDatabaseDriver
mixed
loadColumn()

loadColumn

from AbstractDatabaseDriver
mixed
quoteName(string $text)

quoteName

from AbstractDatabaseDriver
mixed
qn(string $text)

qn

from AbstractDatabaseDriver
string
quote(string $text, bool $escape = true)

quote

from AbstractDatabaseDriver
string
q(string $text, bool $escape = true)

q

from AbstractDatabaseDriver
string
escape(string $text, bool $extra = true)

escape

from AbstractDatabaseDriver
string
e(string $text, bool $extra = true)

e

from AbstractDatabaseDriver
string
getName()

Method to get property Name

from AbstractDatabaseDriver
array
getOptions()

Method to get property Options

from AbstractDatabaseDriver
AbstractDatabaseDriver
setOptions(array $options)

Method to set property options

from AbstractDatabaseDriver
AbstractDatabaseDriver
setDatabaseName(string $database)

Method to set property database

from AbstractDatabaseDriver
AbstractDatabaseDriver
addMiddleware(MiddlewareInterface|callable $middleware)

addMiddleware

from AbstractDatabaseDriver
ChainBuilder
getMiddlewares()

Method to get property Middlewares

from AbstractDatabaseDriver
AbstractDatabaseDriver
resetMiddlewares()

Method to set property middlewares

from AbstractDatabaseDriver
string
getLastQuery()

Method to get property LastQuery

from AbstractDatabaseDriver
static boolean
isSupported()

Is this driver supported.

mixed
getOption(mixed $key)

Retrieve a PDO database connection attribute http://www.php.net/manual/en/pdo.getattribute.php

from PdoDriver
boolean
setOption(integer $key, mixed $value)

Sets an attribute on the PDO database handle.

from PdoDriver
PDOStatement|false
doExecute()

Execute the SQL statement.

from PdoDriver

Details

at line line 45
__construct(null $connection = null, array $options = array())

Constructor.

Parameters

null $connection The database connection instance.
array $options List of options used to configure the connection

in AbstractDatabaseDriver at line line 189
resource|object getConnection()

getConnection

Return Value

resource|object

in AbstractDatabaseDriver at line line 201
AbstractDatabaseDriver setConnection(resource $connection)

setConnection

Parameters

resource $connection

Return Value

AbstractDatabaseDriver Return self to support chaining.

in AbstractDatabaseDriver at line line 216
resource|false execute()

Execute the SQL statement.

Return Value

resource|false Return Resource to do more or false if query failure.

Exceptions

RuntimeException

in PdoDriver at line line 108
AbstractDatabaseDriver connect()

connect

Return Value

AbstractDatabaseDriver

Exceptions

RuntimeException

in PdoDriver at line line 144
AbstractDatabaseDriver disconnect()

Disconnects the database.

Return Value

AbstractDatabaseDriver

in PdoDriver at line line 220
boolean select(string $database)

Select a database for use.

Parameters

string $database The name of the database to select for use.

Return Value

boolean True if the database was successfully selected.

Exceptions

RuntimeException

in PdoDriver at line line 203
string getVersion()

Get the version of the database connector

Return Value

string The database connector version.

in PdoDriver at line line 304
AbstractDatabaseDriver freeResult(mixed $cursor = null)

Method to free up the memory used for the result set.

Parameters

mixed $cursor The optional result set cursor from which to fetch the row.

Return Value

AbstractDatabaseDriver

in PdoDriver at line line 357
mixed listDatabases()

getDatabaseList

Return Value

mixed

Exceptions

LogicException

in AbstractDatabaseDriver at line line 318
resource getCursor()

getCursor

Return Value

resource

in PdoDriver at line line 328
Query getQuery(boolean $new = false)

Get the current query object or a new Query object.

Parameters

boolean $new False to return the current query object, True to return a new Query object.

Return Value

Query The current query object or a new object extending the Query class.

Exceptions

RuntimeException

in AbstractDatabaseDriver at line line 363
AbstractTable getTable(string $name, bool $new = false)

getTable

Parameters

string $name
bool $new

Return Value

AbstractTable

in AbstractDatabaseDriver at line line 383
AbstractDatabase getDatabase(string $name = null, bool $new = false)

getTable

Parameters

string $name
bool $new

Return Value

AbstractDatabase

in AbstractDatabaseDriver at line line 410
AbstractReader getReader(Query $query = null, bool $new = true)

getReader

Parameters

Query $query
bool $new

Return Value

AbstractReader

in AbstractDatabaseDriver at line line 434
AbstractWriter getWriter(bool $new = true)

getWriter

Parameters

bool $new

Return Value

AbstractWriter

in AbstractDatabaseDriver at line line 454
AbstractTransaction getTransaction(boolean $nested = true, bool $new = false)

getWriter

Parameters

boolean $nested
bool $new

Return Value

AbstractTransaction

in AbstractDatabaseDriver at line line 473
DataIterator getIterator(string $class = 'stdClass')

getIterator

Parameters

string $class

Return Value

DataIterator

in AbstractDatabaseDriver at line line 485
string getCurrentDatabase()

Gets the name of the database used by this conneciton.

Return Value

string

in AbstractDatabaseDriver at line line 497
string getPrefix()

Get the common table prefix for the database driver.

Return Value

string The common database table prefix.

at line line 64
string replacePrefix(string $sql, string $prefix = '#__')

This function replaces a string identifier $prefix with the string held is the tablePrefix class variable.

Parameters

string $sql The SQL statement to prepare.
string $prefix The common table prefix.

Return Value

string The processed SQL statement.

in AbstractDatabaseDriver at line line 613
static array splitSql(string $sql)

Splits a string of multiple queries into an array of individual queries.

Parameters

string $sql Input SQL string with which to split into individual queries.

Return Value

array The queries from the input string separated into an array.

in AbstractDatabaseDriver at line line 671
AbstractDatabaseDriver setDebug(boolean $level)

Sets the database debugging state for the driver.

Parameters

boolean $level True to enable debugging.

Return Value

AbstractDatabaseDriver

in PdoDriver at line line 239
AbstractDatabaseDriver setQuery(mixed $query, array $driverOptions = array())

Sets the SQL statement string for later execution.

Parameters

mixed $query The SQL statement to set either as a Query object or a string.
array $driverOptions The optional PDO driver options

Return Value

AbstractDatabaseDriver This object to support method chaining.

in AbstractDatabaseDriver at line line 702
mixed loadAll(string $key = null, string $class = '\\stdClass')

loadAll

Parameters

string $key
string $class

Return Value

mixed

in AbstractDatabaseDriver at line line 724
mixed loadOne(string $class = '\\stdClass')

loadOne

Parameters

string $class

Return Value

mixed

in AbstractDatabaseDriver at line line 744
mixed loadResult()

loadResult

Return Value

mixed

in AbstractDatabaseDriver at line line 754
mixed loadColumn()

loadColumn

Return Value

mixed

in AbstractDatabaseDriver at line line 781
mixed quoteName(string $text)

quoteName

Parameters

string $text

Return Value

mixed

in AbstractDatabaseDriver at line line 793
mixed qn(string $text)

qn

Parameters

string $text

Return Value

mixed

in AbstractDatabaseDriver at line line 806
string quote(string $text, bool $escape = true)

quote

Parameters

string $text
bool $escape

Return Value

string

in AbstractDatabaseDriver at line line 819
string q(string $text, bool $escape = true)

q

Parameters

string $text
bool $escape

Return Value

string

in AbstractDatabaseDriver at line line 832
string escape(string $text, bool $extra = true)

escape

Parameters

string $text
bool $extra

Return Value

string

in AbstractDatabaseDriver at line line 845
string e(string $text, bool $extra = true)

e

Parameters

string $text
bool $extra

Return Value

string

in AbstractDatabaseDriver at line line 855
string getName()

Method to get property Name

Return Value

string

in AbstractDatabaseDriver at line line 865
array getOptions()

Method to get property Options

Return Value

array

in AbstractDatabaseDriver at line line 877
AbstractDatabaseDriver setOptions(array $options)

Method to set property options

Parameters

array $options

Return Value

AbstractDatabaseDriver Return self to support chaining.

in AbstractDatabaseDriver at line line 891
AbstractDatabaseDriver setDatabaseName(string $database)

Method to set property database

Parameters

string $database

Return Value

AbstractDatabaseDriver Return self to support chaining.

in AbstractDatabaseDriver at line line 909
AbstractDatabaseDriver addMiddleware(MiddlewareInterface|callable $middleware)

addMiddleware

Parameters

MiddlewareInterface|callable $middleware

Return Value

AbstractDatabaseDriver

in AbstractDatabaseDriver at line line 923
ChainBuilder getMiddlewares()

Method to get property Middlewares

Return Value

ChainBuilder

in AbstractDatabaseDriver at line line 935
AbstractDatabaseDriver resetMiddlewares()

Method to set property middlewares

Return Value

AbstractDatabaseDriver Return self to support chaining.

in AbstractDatabaseDriver at line line 948
string getLastQuery()

Method to get property LastQuery

Return Value

string

at line line 32
static boolean isSupported()

Is this driver supported.

Return Value

boolean

in PdoDriver at line line 167
mixed getOption(mixed $key)

Retrieve a PDO database connection attribute http://www.php.net/manual/en/pdo.getattribute.php

Usage: $db->getOption(PDO::ATTR_CASE);

Parameters

mixed $key One of the PDO::ATTR_* Constants

Return Value

mixed

in PdoDriver at line line 189
boolean setOption(integer $key, mixed $value)

Sets an attribute on the PDO database handle.

http://www.php.net/manual/en/pdo.setattribute.php

Usage: $db->setOption(PDO::ATTRCASE, PDO::CASEUPPER);

Parameters

integer $key One of the PDO::ATTR_* Constants
mixed $value One of the associated PDO Constants related to the particular attribute key.

Return Value

boolean

in PdoDriver at line line 257
PDOStatement|false doExecute()

Execute the SQL statement.

Return Value

PDOStatement|false A database cursor resource on success, boolean false on failure.

Exceptions

RuntimeException