Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres publiques statiques | Attributs publics | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe JDatabaseDriverPostgresql
+ Graphe d'héritage de JDatabaseDriverPostgresql:
+ Graphe de collaboration de JDatabaseDriverPostgresql:

Liste de tous les membres

Fonctions membres publiques

 __construct ($options)
 __destruct ()
 connect ()
 disconnect ()
 escape ($text, $extra=false)
 connected ()
 dropTable ($tableName, $ifExists=true)
 getAffectedRows ()
 getCollation ()
 getNumRows ($cur=null)
 getQuery ($new=false, $asObj=false)
 getTableCreate ($tables)
 getTableColumns ($table, $typeOnly=true)
 getTableKeys ($table)
 getTableList ()
 getTableSequences ($table)
 getVersion ()
 insertid ()
 lockTable ($tableName)
 execute ()
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 select ($database)
 setUTF ()
 sqlValue ($columns, $field_name, $field_value)
 transactionCommit ($toSavepoint=false)
 transactionRollback ($toSavepoint=false)
 transactionStart ($asSavepoint=false)
 insertObject ($table, &$object, $key=null)
 showTables ()
 getStringPositionSQL ($substring, $string)
 getRandom ()
 getAlterDbCharacterSet ($dbName)
 getCreateDbQuery ($options, $utf)
 replacePrefix ($query, $prefix= '#__')
 releaseTransactionSavepoint ($savepointName)
 transactionSavepoint ($savepointName)
 unlockTables ()
 updateObject ($table, &$object, $key, $nulls=false)
- Fonctions membres publiques inherited from JDatabaseDriver
 __call ($method, $args)
 alterDbCharacterSet ($dbName)
 createDatabase ($options, $utf=true)
 addDisconnectHandler ($callable)
 getConnection ()
 getCount ()
 getDateFormat ()
 getLog ()
 getTimings ()
 getCallStacks ()
 getMinimum ()
 getNullDate ()
 getPrefix ()
 getExporter ()
 getImporter ()
 getQuery ($new=false)
 getIterator ($column=null, $class= 'stdClass')
 getUTFSupport ()
 hasUTFSupport ()
 isMinimumVersion ()
 loadAssoc ()
 loadAssocList ($key=null, $column=null)
 loadColumn ($offset=0)
 loadNextObject ($class= 'stdClass')
 loadNextRow ()
 loadObject ($class= 'stdClass')
 loadObjectList ($key= '', $class= 'stdClass')
 loadResult ()
 loadRow ()
 loadRowList ($key=null)
 quote ($text, $escape=true)
 quoteName ($name, $as=null)
 setDebug ($level)
 setQuery ($query, $offset=0, $limit=0)
 truncateTable ($table)
- Fonctions membres publiques inherited from JDatabase
 query ()
 getErrorMsg ($escaped=false)
 getErrorNum ()
 stderr ($showSQL=false)

Fonctions membres publiques statiques

static test ()
static isSupported ()
- Fonctions membres publiques statiques inherited from JDatabaseDriver
static getConnectors ()
static getInstance ($options=array())
static splitSql ($sql)

Attributs publics

 $name = 'postgresql'
- Attributs publics inherited from JDatabaseDriver

Fonctions membres protégées

 fetchArray ($cursor=null)
 fetchAssoc ($cursor=null)
 fetchObject ($cursor=null, $class= 'stdClass')
 freeResult ($cursor=null)
- Fonctions membres protégées inherited from JDatabaseDriver
 getCreateDatabaseQuery ($options, $utf)
 getDatabase ()
 quoteNameStr ($strArr)

Attributs protégés

 $nameQuote = '"'
 $nullDate = '1970-01-01 00:00:00'
 $concat_operator = '||'
 $queryObject = null
- Attributs protégés inherited from JDatabaseDriver
 $connection
 $count = 0
 $cursor
 $debug = false
 $limit = 0
 $log = array()
 $timings = array()
 $callStacks = array()
 $offset = 0
 $options
 $sql
 $tablePrefix
 $utf = true
 $errorNum = 0
 $errorMsg
 $transactionDepth = 0
 $disconnectHandlers = array()

Attributs protégés statiques

static $dbMinimum = '8.3.18'
- Attributs protégés statiques inherited from JDatabaseDriver
static $instances = array()

Description détaillée

Définition à la ligne 19 du fichier postgresql.php.

Documentation des constructeurs et destructeur

JDatabaseDriverPostgresql::__construct (   $options)

Database object constructor

Paramètres:
array$optionsList of options used to configure the connection
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 76 du fichier postgresql.php.

{
$options['host'] = (isset($options['host'])) ? $options['host'] : 'localhost';
$options['user'] = (isset($options['user'])) ? $options['user'] : '';
$options['password'] = (isset($options['password'])) ? $options['password'] : '';
$options['database'] = (isset($options['database'])) ? $options['database'] : '';
// Finalize initialization
parent::__construct($options);
}
JDatabaseDriverPostgresql::__destruct ( )

Database object destructor

Depuis:
12.1

Définition à la ligne 92 du fichier postgresql.php.

{
$this->disconnect();
}

Documentation des fonctions membres

JDatabaseDriverPostgresql::connect ( )

Connects to the database if needed.

Renvoie:
void Returns void if the database connected successfully.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 105 du fichier postgresql.php.

{
if ($this->connection)
{
return;
}
// Make sure the postgresql extension for PHP is installed and enabled.
if (!function_exists('pg_connect'))
{
throw new RuntimeException('PHP extension pg_connect is not available.');
}
// Build the DSN for the connection.
$dsn = "host={$this->options['host']} dbname={$this->options['database']} user={$this->options['user']} password={$this->options['password']}";
// Attempt to connect to the server.
if (!($this->connection = @pg_connect($dsn)))
{
throw new RuntimeException('Error connecting to PGSQL database.');
}
pg_set_error_verbosity($this->connection, PGSQL_ERRORS_DEFAULT);
pg_query('SET standard_conforming_strings=off');
}
JDatabaseDriverPostgresql::connected ( )

Determines if the connection to the server is active.

Renvoie:
boolean
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 197 du fichier postgresql.php.

{
$this->connect();
if (is_resource($this->connection))
{
return pg_ping($this->connection);
}
return false;
}
JDatabaseDriverPostgresql::disconnect ( )

Disconnects the database.

Renvoie:
void
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 138 du fichier postgresql.php.

{
// Close the connection.
if (is_resource($this->connection))
{
foreach ($this->disconnectHandlers as $h)
{
call_user_func_array($h, array( &$this));
}
pg_close($this->connection);
}
$this->connection = null;
}
JDatabaseDriverPostgresql::dropTable (   $tableName,
  $ifExists = true 
)

Drops a table from the database.

Paramètres:
string$tableNameThe name of the database table to drop.
boolean$ifExistsOptionally specify that the table must exist before it is dropped.
Renvoie:
boolean
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 220 du fichier postgresql.php.

{
$this->connect();
$this->setQuery('DROP TABLE ' . ($ifExists ? 'IF EXISTS ' : '') . $this->quoteName($tableName));
$this->execute();
return true;
}
JDatabaseDriverPostgresql::escape (   $text,
  $extra = false 
)

Method to escape a string for usage in an SQL statement.

Paramètres:
string$textThe string to be escaped.
boolean$extraOptional parameter to provide extra escaping.
Renvoie:
string The escaped string.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 164 du fichier postgresql.php.

{
$this->connect();
$result = pg_escape_string($this->connection, $text);
if ($extra)
{
$result = addcslashes($result, '%_');
}
return $result;
}
JDatabaseDriverPostgresql::execute ( )

Execute the SQL statement.

Renvoie:
mixed A database cursor resource on success, boolean false on failure.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 618 du fichier postgresql.php.

Références JText\_(), JLog\add(), JLog\DEBUG, JLog\ERROR, et JText\sprintf().

{
$this->connect();
if (!is_resource($this->connection))
{
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'database');
throw new RuntimeException($this->errorMsg, $this->errorNum);
}
// Take a local copy so that we don't modify the original query and cause issues later
$query = $this->replacePrefix((string) $this->sql);
if (!($this->sql instanceof JDatabaseQuery) && ($this->limit > 0 || $this->offset > 0))
{
$query .= ' LIMIT ' . $this->limit . ' OFFSET ' . $this->offset;
}
// Increment the query counter.
$this->count++;
// Reset the error values.
$this->errorNum = 0;
$this->errorMsg = '';
// If debugging is enabled then let's log the query.
if ($this->debug)
{
// Add the query to the object queue.
$this->log[] = $query;
JLog::add($query, JLog::DEBUG, 'databasequery');
$this->timings[] = microtime(true);
}
// Execute the query. Error suppression is used here to prevent warnings/notices that the connection has been lost.
$this->cursor = @pg_query($this->connection, $query);
if ($this->debug)
{
$this->timings[] = microtime(true);
if (defined('DEBUG_BACKTRACE_IGNORE_ARGS'))
{
$this->callStacks[] = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
}
else
{
$this->callStacks[] = debug_backtrace();
}
}
// If an error occurred handle it.
if (!$this->cursor)
{
// Check if the server was disconnected.
if (!$this->connected())
{
try
{
// Attempt to reconnect.
$this->connection = null;
$this->connect();
}
// If connect fails, ignore that exception and throw the normal exception.
catch (RuntimeException $e)
{
// Get the error number and message.
$this->errorNum = (int) pg_result_error_field($this->cursor, PGSQL_DIAG_SQLSTATE) . ' ';
$this->errorMsg = JText::_('JLIB_DATABASE_QUERY_FAILED') . "\n" . pg_last_error($this->connection) . "\nSQL=" . $query;
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'databasequery');
throw new RuntimeException($this->errorMsg);
}
// Since we were able to reconnect, run the query again.
return $this->execute();
}
// The server was not disconnected.
else
{
// Get the error number and message.
$this->errorNum = (int) pg_result_error_field($this->cursor, PGSQL_DIAG_SQLSTATE) . ' ';
$this->errorMsg = JText::_('JLIB_DATABASE_QUERY_FAILED') . "\n" . pg_last_error($this->connection) . "\nSQL=" . $query;
// Throw the normal query exception.
JLog::add(JText::sprintf('JLIB_DATABASE_QUERY_FAILED', $this->errorNum, $this->errorMsg), JLog::ERROR, 'databasequery');
throw new RuntimeException($this->errorMsg);
}
}
return $this->cursor;
}

+ Voici le graphe d'appel pour cette fonction :

JDatabaseDriverPostgresql::fetchArray (   $cursor = null)
protected

Method to fetch a row from the result set cursor as an array.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 983 du fichier postgresql.php.

{
return pg_fetch_row($cursor ? $cursor : $this->cursor);
}
JDatabaseDriverPostgresql::fetchAssoc (   $cursor = null)
protected

Method to fetch a row from the result set cursor as an associative array.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 997 du fichier postgresql.php.

{
return pg_fetch_assoc($cursor ? $cursor : $this->cursor);
}
JDatabaseDriverPostgresql::fetchObject (   $cursor = null,
  $class = 'stdClass' 
)
protected

Method to fetch a row from the result set cursor as an object.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
string$classThe class name to use for the returned row object.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1012 du fichier postgresql.php.

{
return pg_fetch_object(is_null($cursor) ? $this->cursor : $cursor, null, $class);
}
JDatabaseDriverPostgresql::freeResult (   $cursor = null)
protected

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

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
void
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1026 du fichier postgresql.php.

{
pg_free_result($cursor ? $cursor : $this->cursor);
}
JDatabaseDriverPostgresql::getAffectedRows ( )

Get the number of affected rows for the previous executed SQL statement.

Renvoie:
integer The number of affected rows in the previous operation
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 237 du fichier postgresql.php.

{
$this->connect();
return pg_affected_rows($this->cursor);
}
JDatabaseDriverPostgresql::getAlterDbCharacterSet (   $dbName)

Get the query string to alter the database character set.

Paramètres:
string$dbNameThe database name
Renvoie:
string The query that alter the database query string
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1189 du fichier postgresql.php.

{
$query = 'ALTER DATABASE ' . $this->quoteName($dbName) . ' SET CLIENT_ENCODING TO ' . $this->quote('UTF8');
return $query;
}
JDatabaseDriverPostgresql::getCollation ( )

Method to get the database collation in use by sampling a text field of a table in the database.

Renvoie:
mixed The collation in use by the database or boolean false if not supported.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 252 du fichier postgresql.php.

{
$this->connect();
$this->setQuery('SHOW LC_COLLATE');
$array = $this->loadAssocList();
return $array[0]['lc_collate'];
}
JDatabaseDriverPostgresql::getCreateDbQuery (   $options,
  $utf 
)

Get the query string to create new Database in correct PostgreSQL syntax.

Paramètres:
object$optionsobject coming from "initialise" function to pass user and database name to database driver.
boolean$utfTrue if the database supports the UTF-8 character set, not used in PostgreSQL "CREATE DATABASE" query.
Renvoie:
string The query that creates database, owned by $options['user']
Depuis:
12.1

Définition à la ligne 1206 du fichier postgresql.php.

{
$query = 'CREATE DATABASE ' . $this->quoteName($options->db_name) . ' OWNER ' . $this->quoteName($options->db_user);
if ($utf)
{
$query .= ' ENCODING ' . $this->quote('UTF-8');
}
return $query;
}
JDatabaseDriverPostgresql::getNumRows (   $cur = null)

Get the number of returned rows for the previous executed SQL statement.

Paramètres:
resource$curAn optional database cursor resource to extract the row count from.
Renvoie:
integer The number of returned rows.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 271 du fichier postgresql.php.

{
$this->connect();
return pg_num_rows((int) $cur ? $cur : $this->cursor);
}
JDatabaseDriverPostgresql::getQuery (   $new = false,
  $asObj = false 
)

Get the current or query, or new JDatabaseQuery object.

Paramètres:
boolean$newFalse to return the last query set, True to return a new JDatabaseQuery object.
boolean$asObjFalse to return last query as string, true to get JDatabaseQueryPostgresql object.
Renvoie:
JDatabaseQuery The current query object or a new object extending the JDatabaseQuery class.
Depuis:
12.1
Exceptions:
RuntimeException

Définition à la ligne 289 du fichier postgresql.php.

{
if ($new)
{
// Make sure we have a query class for this driver.
if (!class_exists('JDatabaseQueryPostgresql'))
{
throw new RuntimeException('JDatabaseQueryPostgresql Class not found.');
}
$this->queryObject = new JDatabaseQueryPostgresql($this);
return $this->queryObject;
}
else
{
if ($asObj)
{
return $this->queryObject;
}
else
{
return $this->sql;
}
}
}
JDatabaseDriverPostgresql::getRandom ( )

Generate a random value

Renvoie:
float The random generated number
Depuis:
12.1

Définition à la ligne 1170 du fichier postgresql.php.

{
$this->connect();
$this->setQuery('SELECT RANDOM()');
$random = $this->loadAssoc();
return $random['random'];
}
JDatabaseDriverPostgresql::getStringPositionSQL (   $substring,
  $string 
)

Get the substring position inside a string

Paramètres:
string$substringThe string being sought
string$stringThe string/column being searched
Renvoie:
integer The position of $substring in $string
Depuis:
12.1

Définition à la ligne 1152 du fichier postgresql.php.

{
$this->connect();
$query = "SELECT POSITION( $substring IN $string )";
$this->setQuery($query);
$position = $this->loadRow();
return $position['position'];
}
JDatabaseDriverPostgresql::getTableColumns (   $table,
  $typeOnly = true 
)

Retrieves field information about a given table.

Paramètres:
string$tableThe name of the database table.
boolean$typeOnlyTrue to only return field types.
Renvoie:
array An array of fields for the database table.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 343 du fichier postgresql.php.

{
$this->connect();
$result = array();
$tableSub = $this->replacePrefix($table);
$this->setQuery('
SELECT a.attname AS "column_name",
pg_catalog.format_type(a.atttypid, a.atttypmod) as "type",
CASE WHEN a.attnotnull IS TRUE
THEN \'NO\'
ELSE \'YES\'
END AS "null",
CASE WHEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true) IS NOT NULL
THEN pg_catalog.pg_get_expr(adef.adbin, adef.adrelid, true)
END as "Default",
CASE WHEN pg_catalog.col_description(a.attrelid, a.attnum) IS NULL
THEN \'\'
ELSE pg_catalog.col_description(a.attrelid, a.attnum)
END AS "comments"
FROM pg_catalog.pg_attribute a
LEFT JOIN pg_catalog.pg_attrdef adef ON a.attrelid=adef.adrelid AND a.attnum=adef.adnum
LEFT JOIN pg_catalog.pg_type t ON a.atttypid=t.oid
WHERE a.attrelid =
(SELECT oid FROM pg_catalog.pg_class WHERE relname=' . $this->quote($tableSub) . '
AND relnamespace = (SELECT oid FROM pg_catalog.pg_namespace WHERE
nspname = \'public\')
)
AND a.attnum > 0 AND NOT a.attisdropped
ORDER BY a.attnum'
);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$result[$field->column_name] = preg_replace("/[(0-9)]/", '', $field->type);
}
}
else
{
foreach ($fields as $field)
{
$result[$field->column_name] = $field;
}
}
/* Change Postgresql's NULL::* type with PHP's null one */
foreach ($fields as $field)
{
if (preg_match("/^NULL::*/", $field->Default))
{
$field->Default = null;
}
}
return $result;
}
JDatabaseDriverPostgresql::getTableCreate (   $tables)

Shows the table CREATE statement that creates the given tables.

This is unsuported by PostgreSQL.

Paramètres:
mixed$tablesA table name or a list of table names.
Renvoie:
string An empty char because this function is not supported by PostgreSQL.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 327 du fichier postgresql.php.

{
return '';
}
JDatabaseDriverPostgresql::getTableKeys (   $table)

Get the details list of keys for a table.

Paramètres:
string$tableThe name of the table.
Renvoie:
array An array of the column specification for the table.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 416 du fichier postgresql.php.

{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList))
{
// Get the details columns information.
$this->setQuery('
SELECT indexname AS "idxName", indisprimary AS "isPrimary", indisunique AS "isUnique",
CASE WHEN indisprimary = true THEN
( SELECT \'ALTER TABLE \' || tablename || \' ADD \' || pg_catalog.pg_get_constraintdef(const.oid, true)
FROM pg_constraint AS const WHERE const.conname= pgClassFirst.relname )
ELSE pg_catalog.pg_get_indexdef(indexrelid, 0, true)
END AS "Query"
FROM pg_indexes
LEFT JOIN pg_class AS pgClassFirst ON indexname=pgClassFirst.relname
LEFT JOIN pg_index AS pgIndex ON pgClassFirst.oid=pgIndex.indexrelid
WHERE tablename=' . $this->quote($table) . ' ORDER BY indkey'
);
$keys = $this->loadObjectList();
return $keys;
}
return false;
}
JDatabaseDriverPostgresql::getTableList ( )

Method to get an array of all tables in the database.

Renvoie:
array An array of all the tables in the database.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 455 du fichier postgresql.php.

{
$this->connect();
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type=' . $this->quote('BASE TABLE'))
->where('table_schema NOT IN (' . $this->quote('pg_catalog') . ', ' . $this->quote('information_schema') . ')')
->order('table_name ASC');
$this->setQuery($query);
$tables = $this->loadColumn();
return $tables;
}
JDatabaseDriverPostgresql::getTableSequences (   $table)

Get the details list of sequences for a table.

Paramètres:
string$tableThe name of the table.
Renvoie:
array An array of sequences specification for the table.
Depuis:
12.1
Exceptions:
RuntimeException

Définition à la ligne 482 du fichier postgresql.php.

{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
if (in_array($table, $tableList))
{
$name = array(
's.relname', 'n.nspname', 't.relname', 'a.attname', 'info.data_type', 'info.minimum_value', 'info.maximum_value',
'info.increment', 'info.cycle_option'
);
$as = array('sequence', 'schema', 'table', 'column', 'data_type', 'minimum_value', 'maximum_value', 'increment', 'cycle_option');
if (version_compare($this->getVersion(), '9.1.0') >= 0)
{
$name[] .= 'info.start_value';
$as[] .= 'start_value';
}
// Get the details columns information.
$query = $this->getQuery(true)
->select($this->quoteName($name, $as))
->from('pg_class AS s')
->join('LEFT', "pg_depend d ON d.objid=s.oid AND d.classid='pg_class'::regclass AND d.refclassid='pg_class'::regclass")
->join('LEFT', 'pg_class t ON t.oid=d.refobjid')
->join('LEFT', 'pg_namespace n ON n.oid=t.relnamespace')
->join('LEFT', 'pg_attribute a ON a.attrelid=t.oid AND a.attnum=d.refobjsubid')
->join('LEFT', 'information_schema.sequences AS info ON info.sequence_name=s.relname')
->where("s.relkind='S' AND d.deptype='a' AND t.relname=" . $this->quote($table));
$this->setQuery($query);
$seq = $this->loadObjectList();
return $seq;
}
return false;
}
JDatabaseDriverPostgresql::getVersion ( )

Get the version of the database connector.

Renvoie:
string The database connector version.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 529 du fichier postgresql.php.

{
$this->connect();
$version = pg_version($this->connection);
return $version['server'];
}
JDatabaseDriverPostgresql::insertid ( )

Method to get the auto-incremented value from the last INSERT statement.

Renvoie:
mixed The value of the auto-increment field from the last inserted row.
Depuis:
11.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 567 du fichier postgresql.php.

{
$this->connect();
$insertQuery = $this->getQuery(false, true);
$table = $insertQuery->__get('insert')->getElements();
/* find sequence column name */
$colNameQuery = $this->getQuery(true);
$colNameQuery->select('column_default')
->from('information_schema.columns')
->where("table_name=" . $this->quote($this->replacePrefix(str_replace('"', '', $table[0]))), 'AND')
->where("column_default LIKE '%nextval%'");
$this->setQuery($colNameQuery);
$colName = $this->loadRow();
$changedColName = str_replace('nextval', 'currval', $colName);
$insertidQuery = $this->getQuery(true);
$insertidQuery->select($changedColName);
$this->setQuery($insertidQuery);
$insertVal = $this->loadRow();
return $insertVal[0];
}
JDatabaseDriverPostgresql::insertObject (   $table,
&  $object,
  $key = null 
)

Inserts a row into a table based on an object's properties.

Paramètres:
string$tableThe name of the database table to insert into.
object&$objectA reference to an object whose public properties match the table fields.
string$keyThe name of the primary key. If provided the object property is updated.
Renvoie:
boolean True on success.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1043 du fichier postgresql.php.

{
$columns = $this->getTableColumns($table);
$fields = array();
$values = array();
// Iterate over the object variables to build the query fields and values.
foreach (get_object_vars($object) as $k => $v)
{
// Only process non-null scalars.
if (is_array($v) or is_object($v) or $v === null)
{
continue;
}
// Ignore any internal fields.
if ($k[0] == '_')
{
continue;
}
// Prepare and sanitize the fields and values for the database query.
$fields[] = $this->quoteName($k);
$values[] = $this->sqlValue($columns, $k, $v);
}
// Create the base insert statement.
$query = $this->getQuery(true)
->insert($this->quoteName($table))
->columns($fields)
->values(implode(',', $values));
$retVal = false;
if ($key)
{
$query->returning($key);
// Set the query and execute the insert.
$this->setQuery($query);
$id = $this->loadResult();
if ($id)
{
$object->$key = $id;
$retVal = true;
}
}
else
{
// Set the query and execute the insert.
$this->setQuery($query);
if ($this->execute())
{
$retVal = true;
}
}
return $retVal;
}
static JDatabaseDriverPostgresql::isSupported ( )
static

Test to see if the PostgreSQL connector is available.

Renvoie:
boolean True on success, false otherwise.
Depuis:
12.1

Implémente JDatabaseInterface.

Définition à la ligne 1114 du fichier postgresql.php.

{
return (function_exists('pg_connect'));
}
JDatabaseDriverPostgresql::lockTable (   $tableName)

Locks a table in the database.

Paramètres:
string$tableNameThe name of the table to unlock.
Renvoie:
JDatabaseDriverPostgresql Returns this object to support chaining.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 602 du fichier postgresql.php.

{
$this->transactionStart();
$this->setQuery('LOCK TABLE ' . $this->quoteName($tableName) . ' IN ACCESS EXCLUSIVE MODE')->execute();
return $this;
}
JDatabaseDriverPostgresql::releaseTransactionSavepoint (   $savepointName)

Method to release a savepoint.

Paramètres:
string$savepointNameSavepoint's name to release
Renvoie:
void
Depuis:
12.1

Définition à la ligne 1303 du fichier postgresql.php.

{
$this->connect();
$this->setQuery('RELEASE SAVEPOINT ' . $this->quoteName($this->escape($savepointName)));
$this->execute();
}
JDatabaseDriverPostgresql::renameTable (   $oldTable,
  $newTable,
  $backup = null,
  $prefix = null 
)

Renames a table in the database.

Paramètres:
string$oldTableThe name of the table to be renamed
string$newTableThe new name for the table.
string$backupNot used by PostgreSQL.
string$prefixNot used by PostgreSQL.
Renvoie:
JDatabaseDriverPostgresql Returns this object to support chaining.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 727 du fichier postgresql.php.

{
$this->connect();
// To check if table exists and prevent SQL injection
$tableList = $this->getTableList();
// Origin Table does not exist
if (!in_array($oldTable, $tableList))
{
// Origin Table not found
throw new RuntimeException('Table not found in Postgresql database.');
}
else
{
/* Rename indexes */
$this->setQuery(
'SELECT relname
FROM pg_class
WHERE oid IN (
SELECT indexrelid
FROM pg_index, pg_class
WHERE pg_class.relname=' . $this->quote($oldTable, true) . '
AND pg_class.oid=pg_index.indrelid );'
);
$oldIndexes = $this->loadColumn();
foreach ($oldIndexes as $oldIndex)
{
$changedIdxName = str_replace($oldTable, $newTable, $oldIndex);
$this->setQuery('ALTER INDEX ' . $this->escape($oldIndex) . ' RENAME TO ' . $this->escape($changedIdxName));
$this->execute();
}
/* Rename sequence */
$this->setQuery(
'SELECT relname
FROM pg_class
WHERE relkind = \'S\'
AND relnamespace IN (
SELECT oid
FROM pg_namespace
WHERE nspname NOT LIKE \'pg_%\'
AND nspname != \'information_schema\'
)
AND relname LIKE \'%' . $oldTable . '%\' ;'
);
$oldSequences = $this->loadColumn();
foreach ($oldSequences as $oldSequence)
{
$changedSequenceName = str_replace($oldTable, $newTable, $oldSequence);
$this->setQuery('ALTER SEQUENCE ' . $this->escape($oldSequence) . ' RENAME TO ' . $this->escape($changedSequenceName));
$this->execute();
}
/* Rename table */
$this->setQuery('ALTER TABLE ' . $this->escape($oldTable) . ' RENAME TO ' . $this->escape($newTable));
$this->execute();
}
return true;
}
JDatabaseDriverPostgresql::replacePrefix (   $query,
  $prefix = '#__' 
)

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

Paramètres:
string$queryThe SQL statement to prepare.
string$prefixThe common table prefix.
Renvoie:
string The processed SQL statement.
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1229 du fichier postgresql.php.

{
$query = trim($query);
if (strpos($query, '\''))
{
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'currval'))
{
$query = explode('currval', $query);
for ($nIndex = 1; $nIndex < count($query); $nIndex = $nIndex + 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix, $query[$nIndex]);
}
$query = implode('currval', $query);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'nextval'))
{
$query = explode('nextval', $query);
for ($nIndex = 1; $nIndex < count($query); $nIndex = $nIndex + 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix, $query[$nIndex]);
}
$query = implode('nextval', $query);
}
// Sequence name quoted with ' ' but need to be replaced
if (strpos($query, 'setval'))
{
$query = explode('setval', $query);
for ($nIndex = 1; $nIndex < count($query); $nIndex = $nIndex + 2)
{
$query[$nIndex] = str_replace($prefix, $this->tablePrefix, $query[$nIndex]);
}
$query = implode('setval', $query);
}
$explodedQuery = explode('\'', $query);
for ($nIndex = 0; $nIndex < count($explodedQuery); $nIndex = $nIndex + 2)
{
if (strpos($explodedQuery[$nIndex], $prefix))
{
$explodedQuery[$nIndex] = str_replace($prefix, $this->tablePrefix, $explodedQuery[$nIndex]);
}
}
$replacedQuery = implode('\'', $explodedQuery);
}
else
{
$replacedQuery = str_replace($prefix, $this->tablePrefix, $query);
}
return $replacedQuery;
}
JDatabaseDriverPostgresql::select (   $database)

Selects the database, but redundant for PostgreSQL

Paramètres:
string$databaseDatabase name to select.
Renvoie:
boolean Always true
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 802 du fichier postgresql.php.

{
return true;
}
JDatabaseDriverPostgresql::setUTF ( )

Custom settings for UTF support

Renvoie:
integer Zero on success, -1 on failure
Depuis:
12.1

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 814 du fichier postgresql.php.

{
$this->connect();
return pg_set_client_encoding($this->connection, 'UTF8');
}
JDatabaseDriverPostgresql::showTables ( )

Returns an array containing database's table list.

Renvoie:
array The database's table list.
Depuis:
12.1

Définition à la ligne 1126 du fichier postgresql.php.

{
$this->connect();
$query = $this->getQuery(true)
->select('table_name')
->from('information_schema.tables')
->where('table_type = ' . $this->quote('BASE TABLE'))
->where('table_schema NOT IN (' . $this->quote('pg_catalog') . ', ' . $this->quote('information_schema') . ' )');
$this->setQuery($query);
$tableList = $this->loadColumn();
return $tableList;
}
JDatabaseDriverPostgresql::sqlValue (   $columns,
  $field_name,
  $field_value 
)

This function return a field value as a prepared string to be used in a SQL statement.

Paramètres:
array$columnsArray of table's column returned by ::getTableColumns.
string$field_nameThe table field's name.
string$field_valueThe variable value to quote and return.
Renvoie:
string The quoted string.
Depuis:
12.1

Définition à la ligne 832 du fichier postgresql.php.

{
switch ($columns[$field_name])
{
case 'boolean':
$val = 'NULL';
if ($field_value == 't')
{
$val = 'TRUE';
}
elseif ($field_value == 'f')
{
$val = 'FALSE';
}
break;
case 'bigint':
case 'bigserial':
case 'integer':
case 'money':
case 'numeric':
case 'real':
case 'smallint':
case 'serial':
case 'numeric,':
$val = strlen($field_value) == 0 ? 'NULL' : $field_value;
break;
case 'date':
case 'timestamp without time zone':
if (empty($field_value))
{
$field_value = $this->getNullDate();
}
$val = $this->quote($field_value);
break;
default:
$val = $this->quote($field_value);
break;
}
return $val;
}
static JDatabaseDriverPostgresql::test ( )
static

Test to see if the PostgreSQL connector is available

Renvoie:
boolean True on success, false otherwise.
Depuis:
12.1

Réimplémentée à partir de JDatabase.

Définition à la ligne 185 du fichier postgresql.php.

{
return (function_exists('pg_connect'));
}
JDatabaseDriverPostgresql::transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

Paramètres:
boolean$toSavepointIf true, commit to the last savepoint.
Renvoie:
void
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 890 du fichier postgresql.php.

{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('COMMIT')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$this->transactionDepth--;
}
JDatabaseDriverPostgresql::transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

Paramètres:
boolean$toSavepointIf true, rollback to the last savepoint.
Renvoie:
void
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 917 du fichier postgresql.php.

{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
if ($this->setQuery('ROLLBACK')->execute())
{
$this->transactionDepth = 0;
}
return;
}
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' . $this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
$this->setQuery('RELEASE SAVEPOINT ' . $this->quoteName($savepoint))->execute();
}
}
JDatabaseDriverPostgresql::transactionSavepoint (   $savepointName)

Method to create a savepoint.

Paramètres:
string$savepointNameSavepoint's name to create
Renvoie:
void
Depuis:
12.1

Définition à la ligne 1319 du fichier postgresql.php.

{
$this->connect();
$this->setQuery('SAVEPOINT ' . $this->quoteName($this->escape($savepointName)));
$this->execute();
}
JDatabaseDriverPostgresql::transactionStart (   $asSavepoint = false)

Method to initialize a transaction.

Paramètres:
boolean$asSavepointIf true and a transaction is already active, a savepoint will be created.
Renvoie:
void
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 951 du fichier postgresql.php.

{
$this->connect();
if (!$asSavepoint || !$this->transactionDepth)
{
if ($this->setQuery('START TRANSACTION')->execute())
{
$this->transactionDepth = 1;
}
return;
}
$savepoint = 'SP_' . $this->transactionDepth;
$this->setQuery('SAVEPOINT ' . $this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth++;
}
}
JDatabaseDriverPostgresql::unlockTables ( )

Unlocks tables in the database, this command does not exist in PostgreSQL, it is automatically done on commit or rollback.

Renvoie:
JDatabaseDriverPostgresql Returns this object to support chaining.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1335 du fichier postgresql.php.

{
$this->transactionCommit();
return $this;
}
JDatabaseDriverPostgresql::updateObject (   $table,
&  $object,
  $key,
  $nulls = false 
)

Updates a row in a table based on an object's properties.

Paramètres:
string$tableThe name of the database table to update.
object&$objectA reference to an object whose public properties match the table fields.
array$keyThe name of the primary key.
boolean$nullsTrue to update null fields or false to ignore them.
Renvoie:
boolean True on success.
Depuis:
12.1
Exceptions:
RuntimeException

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 1355 du fichier postgresql.php.

{
$columns = $this->getTableColumns($table);
$fields = array();
$where = array();
if (is_string($key))
{
$key = array($key);
}
if (is_object($key))
{
$key = (array) $key;
}
// Create the base update statement.
$statement = 'UPDATE ' . $this->quoteName($table) . ' SET %s WHERE %s';
// Iterate over the object variables to build the query fields/value pairs.
foreach (get_object_vars($object) as $k => $v)
{
// Only process scalars that are not internal fields.
if (is_array($v) or is_object($v) or $k[0] == '_')
{
continue;
}
// Set the primary key to the WHERE clause instead of a field to update.
if (in_array($k, $key))
{
$key_val = $this->sqlValue($columns, $k, $v);
$where[] = $this->quoteName($k) . '=' . $key_val;
continue;
}
// Prepare and sanitize the fields and values for the database query.
if ($v === null)
{
// If the value is null and we want to update nulls then set it.
if ($nulls)
{
$val = 'NULL';
}
// If the value is null and we do not want to update nulls then ignore this field.
else
{
continue;
}
}
// The field is not null so we prep it for update.
else
{
$val = $this->sqlValue($columns, $k, $v);
}
// Add the field to be updated.
$fields[] = $this->quoteName($k) . '=' . $val;
}
// We don't have any fields to update.
if (empty($fields))
{
return true;
}
// Set the query and execute the update.
$this->setQuery(sprintf($statement, implode(",", $fields), implode(' AND ', $where)));
return $this->execute();
}

Documentation des données membres

JDatabaseDriverPostgresql::$concat_operator = '||'
protected

Définition à la ligne 59 du fichier postgresql.php.

JDatabaseDriverPostgresql::$dbMinimum = '8.3.18'
staticprotected

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 51 du fichier postgresql.php.

JDatabaseDriverPostgresql::$name = 'postgresql'

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 27 du fichier postgresql.php.

JDatabaseDriverPostgresql::$nameQuote = '"'
protected

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 35 du fichier postgresql.php.

JDatabaseDriverPostgresql::$nullDate = '1970-01-01 00:00:00'
protected

Réimplémentée à partir de JDatabaseDriver.

Définition à la ligne 43 du fichier postgresql.php.

JDatabaseDriverPostgresql::$queryObject = null
protected

Définition à la ligne 67 du fichier postgresql.php.

La documentation de cette classe a été générée à partir du fichier suivant :