Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Fonctions membres publiques | Fonctions membres publiques statiques | Champs de données | Attributs protégés | Attributs protégés statiques | Fonctions membres privées
Référence de la classe PgsqlDriver
+ Graphe d'héritage de PgsqlDriver:

Fonctions membres publiques

 __construct ($options)
 
 connect ()
 
 getCollation ()
 
 getConnectionCollation ()
 
 getConnectionEncryption ()
 
 isConnectionEncryptionSupported ()
 
 getTableCreate ($tables)
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableKeys ($table)
 
 getNamesKey ($table, $indKey)
 
 getTableList ()
 
 getTableSequences ($table)
 
 getSequenceLastValue ($sequence)
 
 getSequenceIsCalled ($sequence)
 
 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)
 
 decodeBinary ($data)
 
- Fonctions membres publiques hérités de PdoDriver
 __construct (array $options)
 
 __destruct ()
 
 connect ()
 
 escape ($text, $extra=false)
 
 execute ()
 
 getOption ($key)
 
 getVersion ()
 
 getConnectedQuery ()
 
 setOption ($key, $value)
 
 connected ()
 
 insertid ()
 
 select ($database)
 
 setUtf ()
 
 transactionCommit ($toSavepoint=false)
 
 transactionRollback ($toSavepoint=false)
 
 transactionStart ($asSavepoint=false)
 
 __sleep ()
 
 __wakeup ()
 
- Fonctions membres publiques hérités de DatabaseDriver
 __get ($name)
 
 __construct (array $options)
 
 __destruct ()
 
 alterDbCharacterSet ($dbName)
 
 createDatabase ($options, $utf=true)
 
 disconnect ()
 
 dropTable ($table, $ifExists=true)
 
 execute ()
 
 getAffectedRows ()
 
 getConnection ()
 
 getCount ()
 
 getDateFormat ()
 
 getMinimum ()
 
 getName ()
 
 getNumRows ()
 
 getServerType ()
 
 getNullDate ()
 
 getPrefix ()
 
 getExporter ()
 
 getImporter ()
 
 getQuery ($new=false)
 
 getIterator ($column=null, $class=\stdClass::class)
 
 getTableCreate ($tables)
 
 hasUtfSupport ()
 
 insertObject ($table, &$object, $key=null)
 
 isMinimumVersion ()
 
 loadAssoc ()
 
 loadAssocList ($key=null, $column=null)
 
 loadColumn ($offset=0)
 
 loadObject ($class=\stdClass::class)
 
 loadObjectList ($key='', $class=\stdClass::class)
 
 loadResult ()
 
 loadRow ()
 
 loadRowList ($key=null)
 
 q ($text, $escape=true)
 
 quote ($text, $escape=true)
 
 quoteBinary ($data)
 
 decodeBinary ($data)
 
 qn ($name, $as=null)
 
 quoteName ($name, $as=null)
 
 replacePrefix ($sql, $prefix='#__')
 
 getMonitor ()
 
 setMonitor (QueryMonitorInterface $monitor=null)
 
 setQuery ($query, $offset=0, $limit=0)
 
 setUtf ()
 
 truncateTable ($table)
 
 updateObject ($table, &$object, $key, $nulls=false)
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 

Fonctions membres publiques statiques

static isSupported ()
 
- Fonctions membres publiques statiques hérités de PdoDriver
static isSupported ()
 
- Fonctions membres publiques statiques hérités de DatabaseDriver
static getInstance (array $options=[])
 
static splitSql ($sql)
 

Champs de données

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

Attributs protégés

 $nameQuote = '"'
 
 $nullDate = '1970-01-01 00:00:00'
 
 $concat_operator = '||'
 
- Attributs protégés hérités de PdoDriver
 $connection
 
 $nameQuote = "'"
 
 $nullDate = '0000-00-00 00:00:00'
 
- Attributs protégés hérités de DatabaseDriver
 $name
 
 $connection
 
 $count = 0
 
 $cursor
 
 $executed = false
 
 $limit = 0
 
 $nameQuote
 
 $nullDate
 
 $offset = 0
 
 $options
 
 $sql
 
 $statement
 
 $tablePrefix
 
 $utf = true
 
 $errorNum = 0
 
 $errorMsg
 
 $transactionDepth = 0
 
 $factory
 
 $monitor
 

Attributs protégés statiques

static $dbMinimum = '9.4.0'
 
- Attributs protégés statiques hérités de DatabaseDriver
static $connectors = []
 
static $instances = []
 
static $dbMinimum
 

Fonctions membres privées

 getDefaultSchema ()
 

Membres hérités additionnels

- Fonctions membres protégées hérités de PdoDriver
 prepareStatement (string $query)
 
- Fonctions membres protégées hérités de DatabaseDriver
 dispatchEvent (EventInterface $event)
 
 fetchArray ()
 
 fetchAssoc ()
 
 fetchObject ()
 
 freeResult ()
 
 getAlterDbCharacterSet ($dbName)
 
 getCreateDatabaseQuery ($options, $utf)
 
 getDatabase ()
 
 prepareStatement (string $query)
 
 quoteNameString ($name, $asSinglePart=false)
 
 quoteNameStr ($strArr)
 

Description détaillée

PostgreSQL PDO Database Driver

Depuis
1.5.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options)

Database object constructor

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

Références DatabaseDriver\$options, Symfony\Contracts\Service\__construct(), et null.

Documentation des fonctions membres

◆ connect()

connect ( )

Connects to the database if needed.

Renvoie
void
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\getConnection(), et DatabaseDriver\setQuery().

Référencé par PgsqlDriver\getNamesKey(), PgsqlDriver\getSequenceIsCalled(), PgsqlDriver\getSequenceLastValue(), PgsqlDriver\getTableColumns(), PgsqlDriver\getTableKeys(), PgsqlDriver\renameTable(), PgsqlDriver\transactionCommit(), PgsqlDriver\transactionRollback(), et PgsqlDriver\transactionStart().

◆ decodeBinary()

decodeBinary (   $data)

Replace special placeholder representing binary field with the original string.

Paramètres
string | resource$dataEncoded string or resource.
Renvoie
string The original string.
Depuis
1.7.0

Implémente DatabaseInterface.

Références $data.

◆ 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
1.5.0

Références DatabaseDriver\quote(), et DatabaseDriver\quoteName().

◆ getCollation()

getCollation ( )

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

Renvoie
string|boolean The collation in use by the database or boolean false if not supported.
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\loadAssocList(), et DatabaseDriver\setQuery().

◆ getConnectionCollation()

getConnectionCollation ( )

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

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

Implémente DatabaseInterface.

Références DatabaseDriver\loadAssocList(), et DatabaseDriver\setQuery().

◆ getConnectionEncryption()

getConnectionEncryption ( )

Method to get the database encryption details (cipher and protocol) in use.

Renvoie
string The database encryption details.
Depuis
2.0.0
Exceptions

Implémente DatabaseInterface.

Références $query, DatabaseDriver\getQuery(), PdoDriver\getVersion(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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
1.5.0

Références DatabaseDriver\$options, $query, DatabaseDriver\$utf, DatabaseDriver\quote(), et DatabaseDriver\quoteName().

◆ 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
1.8.0

Références DatabaseDriver\loadResult(), et DatabaseDriver\setQuery().

Référencé par PgsqlDriver\getTableColumns().

◆ getNamesKey()

getNamesKey (   $table,
  $indKey 
)

Get the list of column names this index indexes.

Paramètres
string$tableThe name of the table.
string$indKeyThe list of column numbers for the table
Renvoie
string A list of the column names for the table.
Depuis
2.0.0
Exceptions

Références $query, PgsqlDriver\connect(), DatabaseDriver\getQuery(), DatabaseDriver\loadResult(), DatabaseDriver\quote(), PgsqlDriver\replacePrefix(), et DatabaseDriver\setQuery().

◆ getRandom()

getRandom ( )

Generate a random value

Renvoie
float The random generated number
Depuis
1.5.0

Références DatabaseDriver\loadAssoc(), et DatabaseDriver\setQuery().

◆ getSequenceIsCalled()

getSequenceIsCalled (   $sequence)

Method to get the is_called attribute of a sequence.

Paramètres
string$sequenceThe name of the sequence.
Renvoie
boolean The is_called attribute of the sequence.
Depuis
2.0.0
Exceptions

Références $query, PgsqlDriver\connect(), DatabaseDriver\getQuery(), DatabaseDriver\loadResult(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ getSequenceLastValue()

getSequenceLastValue (   $sequence)

Method to get the last value of a sequence in the database.

Paramètres
string$sequenceThe name of the sequence.
Renvoie
integer The last value of the sequence.
Depuis
2.0.0
Exceptions

Références $query, PgsqlDriver\connect(), DatabaseDriver\getQuery(), DatabaseDriver\loadResult(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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
1.5.0

Références $position, DatabaseDriver\loadRow(), et DatabaseDriver\setQuery().

◆ 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
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $field, $fields, $result, PgsqlDriver\connect(), PgsqlDriver\getDefaultSchema(), DatabaseDriver\loadObjectList(), null, DatabaseDriver\quote(), PgsqlDriver\replacePrefix(), et DatabaseDriver\setQuery().

Référencé par PgsqlDriver\insertObject(), et PgsqlDriver\updateObject().

◆ 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
1.5.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
1.5.0
Exceptions

Implémente DatabaseInterface.

Références PgsqlDriver\connect(), PgsqlDriver\getTableList(), DatabaseDriver\loadObjectList(), DatabaseDriver\quote(), PgsqlDriver\replacePrefix(), et DatabaseDriver\setQuery().

◆ 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
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $query, DatabaseDriver\getQuery(), DatabaseDriver\loadColumn(), DatabaseDriver\quote(), et DatabaseDriver\setQuery().

Référencé par PgsqlDriver\getTableKeys(), PgsqlDriver\getTableSequences(), et PgsqlDriver\renameTable().

◆ 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
1.5.0
Exceptions

Références PgsqlDriver\$name, $query, DatabaseDriver\getQuery(), PgsqlDriver\getTableList(), DatabaseDriver\loadObjectList(), DatabaseDriver\quote(), DatabaseDriver\quoteName(), PgsqlDriver\replacePrefix(), et DatabaseDriver\setQuery().

◆ 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
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $columns, $fields, $key, $query, DatabaseDriver\getQuery(), PgsqlDriver\getTableColumns(), null, DatabaseDriver\quoteName(), DatabaseDriver\setQuery(), et PgsqlDriver\sqlValue().

◆ isConnectionEncryptionSupported()

isConnectionEncryptionSupported ( )

Method to test if the database TLS connections encryption are supported.

Renvoie
boolean Whether the database supports TLS connections encryption.
Depuis
2.0.0

Implémente DatabaseInterface.

Références DatabaseDriver\setQuery().

◆ isSupported()

static isSupported ( )
static

Test to see if the PostgreSQL connector is available.

Renvoie
boolean True on success, false otherwise.
Depuis
1.5.0

Implémente DatabaseInterface.

◆ lockTable()

lockTable (   $tableName)

Locks a table in the database.

Paramètres
string$tableNameThe name of the table to unlock.
Renvoie
$this
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $this, DatabaseDriver\quoteName(), DatabaseDriver\setQuery(), et PgsqlDriver\transactionStart().

◆ quoteBinary()

quoteBinary (   $data)

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

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

Implémente DatabaseInterface.

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
$this
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $this, PgsqlDriver\connect(), PdoDriver\escape(), DatabaseDriver\getQuery(), PgsqlDriver\getTableList(), DatabaseDriver\loadColumn(), DatabaseDriver\quote(), PgsqlDriver\replacePrefix(), PdoDriver\select(), et DatabaseDriver\setQuery().

◆ replacePrefix()

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

This function replaces a string identifier with the configured table prefix.

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

Implémente DatabaseInterface.

Références $prefix, et DatabaseDriver\$sql.

Référencé par PgsqlDriver\getNamesKey(), PgsqlDriver\getTableColumns(), PgsqlDriver\getTableKeys(), PgsqlDriver\getTableSequences(), et PgsqlDriver\renameTable().

◆ showTables()

showTables ( )

Returns an array containing database's table list.

Renvoie
array The database's table list.
Depuis
1.5.0

Références $query, DatabaseDriver\getQuery(), DatabaseDriver\loadColumn(), DatabaseDriver\quote(), et DatabaseDriver\setQuery().

◆ 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
1.5.0

Références $columns, $fieldValue, $val, elseif, DatabaseDriver\getNullDate(), et DatabaseDriver\quote().

Référencé par PgsqlDriver\insertObject(), et PgsqlDriver\updateObject().

◆ transactionCommit()

transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

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

Implémente DatabaseInterface.

Références PgsqlDriver\connect().

Référencé par PgsqlDriver\unlockTables().

◆ transactionRollback()

transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

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

Implémente DatabaseInterface.

Références PgsqlDriver\connect(), PdoDriver\execute(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

◆ 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
1.0
Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\$transactionDepth, PgsqlDriver\connect(), PdoDriver\execute(), DatabaseDriver\quoteName(), et DatabaseDriver\setQuery().

Référencé par PgsqlDriver\lockTable().

◆ unlockTables()

unlockTables ( )

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

Renvoie
$this
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $this, et PgsqlDriver\transactionCommit().

◆ 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 | string$keyThe name of the primary key.
boolean$nullsTrue to update null fields or false to ignore them.
Renvoie
boolean
Depuis
1.5.0
Exceptions

Implémente DatabaseInterface.

Références $columns, $fields, $key, DatabaseDriver\$statement, $val, PdoDriver\execute(), PgsqlDriver\getTableColumns(), null, DatabaseDriver\quoteName(), DatabaseDriver\setQuery(), et PgsqlDriver\sqlValue().

Documentation des champs

◆ $concat_operator

$concat_operator = '||'
protected

◆ $dbMinimum

$dbMinimum = '9.4.0'
staticprotected

◆ $name

$name = 'pgsql'

Référencé par PgsqlDriver\getTableSequences().

◆ $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 :