Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Référence de la classe JDatabaseDriverPgsql
+ Graphe d'héritage de JDatabaseDriverPgsql:

Fonctions membres publiques

 __construct ($options)
 
 connect ()
 
 dropTable ($tableName, $ifExists=true)
 
 getCollation ()
 
 getConnectionCollation ()
 
 getTableCreate ($tables)
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableKeys ($table)
 
 getTableList ()
 
 getTableSequences ($table)
 
 lockTable ($tableName)
 
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 
 sqlValue ($columns, $fieldName, $fieldValue)
 
 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 ($sql, $prefix='#__')
 
 unlockTables ()
 
 updateObject ($table, &$object, $key, $nulls=false)
 
 quoteBinary ($data)
 
- Fonctions membres publiques hérités de JDatabaseDriverPdo
 __construct ($options)
 
 connect ()
 
 disconnect ()
 
 escape ($text, $extra=false)
 
 execute ()
 
 getOption ($key)
 
 getConnectedQuery ()
 
 getVersion ()
 
 setOption ($key, $value)
 
 connected ()
 
 getAffectedRows ()
 
 getNumRows ($cursor=null)
 
 insertid ()
 
 select ($database)
 
 setQuery ($query, $offset=null, $limit=null, $driverOptions=array())
 
 setUtf ()
 
 transactionCommit ($toSavepoint=false)
 
 transactionRollback ($toSavepoint=false)
 
 transactionStart ($asSavepoint=false)
 
 loadNextObject ($class='stdClass')
 
 loadNextAssoc ()
 
 loadNextRow ()
 
 __sleep ()
 
 __wakeup ()
 
- Fonctions membres publiques hérités de JDatabaseDriver
 __call ($method, $args)
 
 __construct ($options)
 
 alterDbCharacterSet ($dbName)
 
 alterTableCharacterSet ($tableName, $rethrow=false)
 
 connect ()
 
 connected ()
 
 createDatabase ($options, $utf=true)
 
 __destruct ()
 
 disconnect ()
 
 addDisconnectHandler ($callable)
 
 dropTable ($table, $ifExists=true)
 
 escape ($text, $extra=false)
 
 getAffectedRows ()
 
 getAlterDbCharacterSet ($dbName)
 
 getAlterTableCharacterSet ($tableName)
 
 convertUtf8mb4QueryToUtf8 ($query)
 
 getCollation ()
 
 getConnectionCollation ()
 
 getConnection ()
 
 getCount ()
 
 getDateFormat ()
 
 getLog ()
 
 getTimings ()
 
 getCallStacks ()
 
 getMinimum ()
 
 getNullDate ()
 
 getNumRows ($cursor=null)
 
 getPrefix ()
 
 getExporter ()
 
 getImporter ()
 
 getName ()
 
 getServerType ()
 
 getQuery ($new=false)
 
 getIterator ($column=null, $class='stdClass')
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableCreate ($tables)
 
 getTableKeys ($table)
 
 getTableList ()
 
 getUTFSupport ()
 
 hasUTFSupport ()
 
 hasUTF8mb4Support ()
 
 getVersion ()
 
 insertid ()
 
 insertObject ($table, &$object, $key=null)
 
 isMinimumVersion ()
 
 loadAssoc ()
 
 loadAssocList ($key=null, $column=null)
 
 loadColumn ($offset=0)
 
 loadNextObject ($class='stdClass')
 
 loadNextRow ()
 
 loadObject ($class='stdClass')
 
 loadObjectList ($key='', $class='stdClass')
 
 loadResult ()
 
 loadRow ()
 
 loadRowList ($index=null)
 
 lockTable ($tableName)
 
 quote ($text, $escape=true)
 
 quoteBinary ($data)
 
 quoteName ($name, $as=null)
 
 replacePrefix ($sql, $prefix='#__')
 
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 
 select ($database)
 
 setDebug ($level)
 
 setQuery ($query, $offset=0, $limit=0)
 
 setUtf ()
 
 transactionCommit ($toSavepoint=false)
 
 transactionRollback ($toSavepoint=false)
 
 transactionStart ($asSavepoint=false)
 
 truncateTable ($table)
 
 updateObject ($table, &$object, $key, $nulls=false)
 
 execute ()
 
 unlockTables ()
 
- Fonctions membres publiques hérités de JDatabase
 query ()
 
 getErrorMsg ($escaped=false)
 
 getErrorNum ()
 
 stderr ($showSQL=false)
 

Fonctions membres publiques statiques

static isSupported ()
 
- Fonctions membres publiques statiques hérités de JDatabaseDriverPdo
static isSupported ()
 
- Fonctions membres publiques statiques hérités de JDatabaseDriver
static getConnectors ()
 
static getInstance ($options=array())
 
static splitSql ($sql)
 
- Fonctions membres publiques statiques hérités de JDatabase
static getConnectors ()
 
static getInstance ($options=array())
 
static splitSql ($query)
 
static test ()
 

Champs de données

 $name = 'pgsql'
 
- Champs de données hérités de JDatabaseDriverPdo
 $name = 'pdo'
 
- Champs de données hérités de JDatabaseDriver
 $name
 
 $serverType
 

Attributs protégés

 $nameQuote = '"'
 
 $nullDate = '1970-01-01 00:00:00'
 
 $concat_operator = '||'
 
- Attributs protégés hérités de JDatabaseDriverPdo
 $connection
 
 $nameQuote = "'"
 
 $nullDate = '0000-00-00 00:00:00'
 
 $prepared
 
 $executed = false
 
- Attributs protégés hérités de JDatabaseDriver
 $connection
 
 $count = 0
 
 $cursor
 
 $debug = false
 
 $limit = 0
 
 $log = array()
 
 $timings = array()
 
 $callStacks = array()
 
 $nameQuote
 
 $nullDate
 
 $offset = 0
 
 $options
 
 $sql
 
 $tablePrefix
 
 $utf = true
 
 $utf8mb4 = false
 
 $errorNum = 0
 
 $errorMsg
 
 $transactionDepth = 0
 
 $disconnectHandlers = array()
 

Attributs protégés statiques

static $dbMinimum = '8.3.18'
 
- Attributs protégés statiques hérités de JDatabaseDriver
static $instances = array()
 
static $dbMinimum
 

Fonctions membres privées

 getDefaultSchema ()
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JDatabaseDriverPdo
 fetchArray ($cursor=null)
 
 fetchAssoc ($cursor=null)
 
 fetchObject ($cursor=null, $class='stdClass')
 
 freeResult ($cursor=null)
 
 getErrorNumber ()
 
 getErrorMessage ()
 
- Fonctions membres protégées hérités de JDatabaseDriver
 fetchArray ($cursor=null)
 
 fetchAssoc ($cursor=null)
 
 fetchObject ($cursor=null, $class='stdClass')
 
 freeResult ($cursor=null)
 
 getCreateDatabaseQuery ($options, $utf)
 
 getDatabase ()
 
 quoteNameStr ($strArr)
 

Description détaillée

PostgreSQL PDO Database Driver

3.9.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options)

Database object constructor

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

Références $options, et null.

Documentation des fonctions membres

◆ connect()

connect ( )

Connects to the database if needed.

Renvoie
void Returns void if the database connected successfully.
Depuis
3.9.0
Exceptions

◆ dropTable()

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 true
Depuis
3.9.0
Exceptions

◆ getAlterDbCharacterSet()

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
3.9.0

◆ getCollation()

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
3.9.0
Exceptions

◆ getConnectionCollation()

getConnectionCollation ( )

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

Renvoie
mixed The collation in use by the database connection (string) or boolean false if not supported.
Depuis
3.9.0
Exceptions

◆ getCreateDbQuery()

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
3.9.0

Références $options, et $query.

◆ getDefaultSchema()

getDefaultSchema ( )
private

Internal function to get the name of the default schema for the current PostgreSQL connection. That is the schema where tables are created by Joomla.

Renvoie
string
Depuis
3.9.24

◆ getRandom()

getRandom ( )

Generate a random value

Renvoie
float The random generated number
Depuis
3.9.0

◆ getStringPositionSql()

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
3.9.0

Références $position.

◆ getTableColumns()

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
3.9.0
Exceptions

Références $field, $fields, et null.

◆ getTableCreate()

getTableCreate (   $tables)

Shows the table CREATE statement that creates the given tables.

This is unsupported by PostgreSQL.

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

◆ getTableKeys()

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
3.9.0
Exceptions

◆ getTableList()

getTableList ( )

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

Renvoie
array An array of all the tables in the database.
Depuis
3.9.0
Exceptions

Références $query.

◆ getTableSequences()

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
3.9.0
Exceptions

Références $name, et $query.

◆ insertObject()

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
3.9.0
Exceptions

Références $columns, $fields, $id, $key, $query, et null.

◆ isSupported()

static isSupported ( )
static

Test to see if the PostgreSQL connector is available.

Renvoie
boolean True on success, false otherwise.
Depuis
3.9.0

Implémente JDatabaseInterface.

◆ lockTable()

lockTable (   $tableName)

Locks a table in the database.

Paramètres
string$tableNameThe name of the table to unlock.
Renvoie
JDatabaseDriverPgsql Returns this object to support chaining.
Depuis
3.9.0
Exceptions

◆ quoteBinary()

quoteBinary (   $data)

Quotes a binary string to database requirements for use in database queries.

Paramètres
mixed$dataA binary string to quote.
Renvoie
string The binary quoted input string.
Depuis
3.9.12

Références $data.

◆ renameTable()

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
JDatabaseDriverPgsql Returns this object to support chaining.
Depuis
3.9.0
Exceptions

◆ replacePrefix()

replacePrefix (   $sql,
  $prefix = '#__' 
)

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

Paramètres
string$sqlThe SQL statement to prepare.
string$prefixThe common table prefix.
Renvoie
string The processed SQL statement.
Depuis
3.9.0

Références $prefix.

◆ showTables()

showTables ( )

Returns an array containing database's table list.

Renvoie
array The database's table list.
Depuis
3.9.0

Références $query.

◆ sqlValue()

sqlValue (   $columns,
  $fieldName,
  $fieldValue 
)

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$fieldNameThe table field's name.
string$fieldValueThe variable value to quote and return.
Renvoie
string The quoted string.
Depuis
3.9.0

Références $columns, $fieldValue, et elseif.

◆ transactionCommit()

transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

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

◆ transactionRollback()

transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

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

◆ transactionStart()

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
3.9.0
Exceptions

◆ unlockTables()

unlockTables ( )

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

Renvoie
JDatabaseDriverPgsql Returns this object to support chaining.
Depuis
3.9.0
Exceptions

◆ updateObject()

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
Depuis
3.9.0
Exceptions

Références $columns, $fields, $key, et null.

Documentation des champs

◆ $concat_operator

$concat_operator = '||'
protected

◆ $dbMinimum

$dbMinimum = '8.3.18'
staticprotected

◆ $name

$name = 'pgsql'

◆ $nameQuote

$nameQuote = '"'
protected

◆ $nullDate

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

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