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 | Fonctions membres protégées | Attributs protégés
Référence de la classe PdoDriver
+ Graphe d'héritage de PdoDriver:

Fonctions membres publiques

 __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 DatabaseInterface
 getCollation ()
 
 getConnectionCollation ()
 
 getConnectionEncryption ()
 
 isConnectionEncryptionSupported ()
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableKeys ($tables)
 
 getTableList ()
 
 lockTable ($tableName)
 
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 
 unlockTables ()
 
- 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 DatabaseDriver
static getInstance (array $options=[])
 
static splitSql ($sql)
 

Champs de données

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

Fonctions membres protégées

 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)
 

Attributs protégés

 $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
 

Membres hérités additionnels

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

Description détaillée

Joomla Framework PDO Database Driver Class

1.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( array  $options)

Constructor.

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

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

Référencé par PdoDriver\__wakeup().

◆ __destruct()

__destruct ( )

Destructor.

Depuis
1.0

Références DatabaseDriver\disconnect().

Documentation des fonctions membres

◆ __sleep()

__sleep ( )

PDO does not support serialize

Renvoie
array
Depuis
1.0

Références $this.

◆ __wakeup()

__wakeup ( )

Wake up after serialization

Renvoie
void
Depuis
1.0

Références PdoDriver\__construct().

◆ connect()

connect ( )

Connects to the database if needed.

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

Implémente DatabaseInterface.

Références $format, $key, $this, $value, DatabaseDriver\dispatchEvent(), null, DatabaseEvents\POST_CONNECT, et PdoDriver\setOption().

Référencé par PdoDriver\execute(), PdoDriver\getOption(), PdoDriver\getVersion(), PdoDriver\insertid(), PdoDriver\select(), PdoDriver\setOption(), PdoDriver\transactionCommit(), PdoDriver\transactionRollback(), et PdoDriver\transactionStart().

◆ connected()

connected ( )

Determines if the connection to the server is active.

Renvoie
boolean True if connected to the database engine.
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\$limit, DatabaseDriver\$offset, DatabaseDriver\$sql, DatabaseDriver\$statement, PdoDriver\getConnectedQuery(), Joomla\Database\Query\limit(), DatabaseDriver\loadResult(), Joomla\Database\Query\offset(), et DatabaseDriver\setQuery().

Référencé par PdoDriver\execute().

◆ escape()

escape (   $text,
  $extra = false 
)

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

Oracle escaping reference: http://www.orafaq.com/wiki/SQL_FAQ#How_does_one_escape_special_characters_when_writing_SQL_queries.3F

SQLite escaping notes: http://www.sqlite.org/faq.html#q14

Method body is as implemented by the Zend Framework

Note: Using query objects with bound variables is preferable to the below.

Paramètres
string$textThe string to be escaped.
boolean$extraUnused optional parameter to provide extra escaping.
Renvoie
string The escaped string.
Depuis
1.0

Implémente DatabaseInterface.

Références $text.

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

◆ execute()

execute ( )

Execute the SQL statement.

Renvoie
boolean
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références DatabaseDriver\$errorMsg, DatabaseDriver\$errorNum, $key, DatabaseDriver\$sql, PdoDriver\connect(), PdoDriver\connected(), null, et DatabaseDriver\replacePrefix().

Référencé par PgsqlDriver\transactionRollback(), MysqlDriver\transactionRollback(), PgsqlDriver\transactionStart(), MysqlDriver\transactionStart(), et PgsqlDriver\updateObject().

◆ getConnectedQuery()

getConnectedQuery ( )

Get a query to run and verify the database is operational.

Renvoie
string The query to check the health of the DB.
Depuis
1.0

Référencé par PdoDriver\connected().

◆ getOption()

getOption (   $key)

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

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

Paramètres
mixed$keyOne of the PDO::ATTR_* Constants
Renvoie
mixed
Depuis
1.0

Références $key, et PdoDriver\connect().

Référencé par SqliteDriver\getTableColumns(), SqliteDriver\getTableKeys(), MysqlDriver\getVersion(), et PdoDriver\getVersion().

◆ getVersion()

getVersion ( )

Get the version of the database connector.

Renvoie
string The database connector version.
Depuis
1.5.0

Implémente DatabaseInterface.

Références PdoDriver\connect(), et PdoDriver\getOption().

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

◆ insertid()

insertid ( )

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

Renvoie
string The value of the auto-increment field from the last inserted row.
Depuis
1.0

Implémente DatabaseInterface.

Références PdoDriver\connect().

Référencé par MysqlDriver\insertObject().

◆ isSupported()

static isSupported ( )
static

Test to see if the PDO extension is available. Override as needed to check for specific PDO Drivers.

Renvoie
boolean True on success, false otherwise.
Depuis
1.0

Implémente DatabaseInterface.

◆ prepareStatement()

prepareStatement ( string  $query)
protected

Prepares a SQL statement for execution

Paramètres
string$queryThe SQL query to be prepared.
Renvoie
StatementInterface
Depuis
2.0.0
Exceptions
PrepareStatementFailureException

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

◆ select()

select (   $database)

Select a database for use.

Paramètres
string$databaseThe name of the database to select for use.
Renvoie
boolean True if the database was successfully selected.
Depuis
1.0
Exceptions

Implémente DatabaseInterface.

Références PdoDriver\connect().

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

◆ setOption()

setOption (   $key,
  $value 
)

Sets an attribute on the PDO database handle. https://www.php.net/manual/en/pdo.setattribute.php

Usage: $db->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);

Paramètres
integer$keyOne of the PDO::ATTR_* Constants
mixed$valueOne of the associated PDO Constants related to the particular attribute key.
Renvoie
boolean
Depuis
1.0

Références $key, $value, et PdoDriver\connect().

Référencé par PdoDriver\connect(), SqliteDriver\getTableColumns(), et SqliteDriver\getTableKeys().

◆ setUtf()

setUtf ( )

Set the connection to use UTF-8 character encoding.

Renvoie
boolean True on success.
Depuis
1.0

◆ 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 PdoDriver\connect().

◆ 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 PdoDriver\connect().

◆ 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 PdoDriver\connect().

Documentation des champs

◆ $connection

$connection
protected

◆ $name

$name = 'pdo'

◆ $nameQuote

$nameQuote = "'"
protected

◆ $nullDate

$nullDate = '0000-00-00 00:00:00'
protected
La documentation de cette classe a été générée à partir du fichier suivant :