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é
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDatabaseDriverOracle
+ Graphe d'héritage de JDatabaseDriverOracle:

Fonctions membres publiques

 __construct ($options)
 
 connect ()
 
 disconnect ()
 
 dropTable ($tableName, $ifExists=true)
 
 getCollation ()
 
 getConnectionCollation ()
 
 getConnectedQuery ()
 
 getDateFormat ()
 
 getTableCreate ($tables)
 
 getTableColumns ($table, $typeOnly=true)
 
 getTableKeys ($table)
 
 getTableList ($databaseName=null, $includeDatabaseName=false)
 
 getVersion ()
 
 select ($database)
 
 setDateFormat ($dateFormat='DD-MON-RR')
 
 setUtf ()
 
 lockTable ($table)
 
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 
 unlockTables ()
 
 replacePrefix ($query, $prefix='#__')
 
 transactionCommit ($toSavepoint=false)
 
 transactionRollback ($toSavepoint=false)
 
 transactionStart ($asSavepoint=false)
 
 getAlterTableCharacterSet ($tableName)
 
- 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 = 'oracle'
 
 $serverType = 'oracle'
 
- Champs de données hérités de JDatabaseDriverPdo
 $name = 'pdo'
 
- Champs de données hérités de JDatabaseDriver
 $name
 
 $serverType
 

Fonctions membres protégées

 getCreateDatabaseQuery ($options, $utf)
 
- 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)
 

Attributs protégés

 $nameQuote = '"'
 
 $dateformat
 
 $charset
 
- 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()
 

Membres hérités additionnels

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

Description détaillée

Oracle database driver

3.0.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options)

Constructor.

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

Références $options.

Documentation des fonctions membres

◆ connect()

connect ( )

Connects to the database if needed.

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

◆ disconnect()

disconnect ( )

Disconnects the database.

Renvoie
void
Depuis
3.0.0

Références null.

◆ dropTable()

dropTable (   $tableName,
  $ifExists = true 
)

Drops a table from the database.

Note: The IF EXISTS flag is unused in the Oracle driver.

Paramètres
string$tableNameThe name of the database table to drop.
boolean$ifExistsOptionally specify that the table must exist before it is dropped.
Renvoie
JDatabaseDriverOracle Returns this object to support chaining.
Depuis
3.0.0

Références $query.

◆ getAlterTableCharacterSet()

getAlterTableCharacterSet (   $tableName)

Get the query strings to alter the character set and collation of a table.

Paramètres
string$tableNameThe name of the table
Renvoie
string[] The queries required to alter the table's character set and collation
Depuis
CMS 3.5.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.0.0

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

◆ getConnectionCollation()

getConnectionCollation ( )

Method to get the database connection collation, as reported by the driver. If the connector doesn't support reporting this value please return an empty string.

Renvoie
string

◆ getCreateDatabaseQuery()

getCreateDatabaseQuery (   $options,
  $utf 
)
protected

Return the query string to create new Database. Each database driver, other than MySQL, need to override this member to return correct string.

Paramètres
stdClass$optionsObject used to pass user and database name to database driver. This object must have "db_name" and "db_user" set.
boolean$utfTrue if the database supports the UTF-8 character set.
Renvoie
string The query that creates database
Depuis
3.0.1

Références $options.

◆ getDateFormat()

getDateFormat ( )

Returns the current date format This method should be useful in the case that somebody actually wants to use a different date format and needs to check what the current one is to see if it needs to be changed.

Renvoie
string The current date format
Depuis
3.0.0

◆ 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.0.0
Exceptions
RuntimeException

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

◆ getTableCreate()

getTableCreate (   $tables)

Shows the table CREATE statement that creates the given tables.

Note: You must have the correct privileges before this method will return usable results!

Paramètres
mixed$tablesA table name or a list of table names.
Renvoie
array A list of the create SQL for the tables.
Depuis
3.0.0
Exceptions
RuntimeException

Références $query.

◆ 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.0.0
Exceptions
RuntimeException

Références $query.

◆ getTableList()

getTableList (   $databaseName = null,
  $includeDatabaseName = false 
)

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

Paramètres
string$databaseNameThe database (schema) name
boolean$includeDatabaseNameWhether to include the schema name in the results
Renvoie
array An array of all the tables in the database.
Depuis
3.0.0
Exceptions
RuntimeException

Références $query.

◆ getVersion()

getVersion ( )

Get the version of the database connector.

Renvoie
string The database connector version.
Depuis
3.0.0

◆ isSupported()

static isSupported ( )
static

Test to see if the PDO ODBC connector is available.

Renvoie
boolean True on success, false otherwise.
Depuis
3.0.0

Implémente JDatabaseInterface.

◆ lockTable()

lockTable (   $table)

Locks a table in the database.

Paramètres
string$tableThe name of the table to unlock.
Renvoie
JDatabaseDriverOracle Returns this object to support chaining.
Depuis
3.0.0
Exceptions
RuntimeException

◆ 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 Oracle.
string$prefixNot used by Oracle.
Renvoie
JDatabaseDriverOracle Returns this object to support chaining.
Depuis
3.0.0
Exceptions
RuntimeException

◆ replacePrefix()

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
1.7.0

Références $n, $prefix, et $query.

◆ 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
3.0.0
Exceptions
RuntimeException

◆ setDateFormat()

setDateFormat (   $dateFormat = 'DD-MON-RR')

Sets the Oracle Date Format for the session Default date format for Oracle is = DD-MON-RR The default date format for this driver is: 'RRRR-MM-DD HH24:MI:SS' since it is the format that matches the MySQL one used within most Joomla tables.

Paramètres
string$dateFormatOracle Date Format String
Renvoie
boolean
Depuis
3.0.0

◆ setUtf()

setUtf ( )

Set the connection to use UTF-8 character encoding.

Returns false automatically for the Oracle driver since you can only set the character set when the connection is created.

Renvoie
boolean True on success.
Depuis
3.0.0

◆ transactionCommit()

transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

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

◆ transactionRollback()

transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

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

◆ 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.1.4
Exceptions
RuntimeException

◆ unlockTables()

unlockTables ( )

Unlocks tables in the database.

Renvoie
JDatabaseDriverOracle Returns this object to support chaining.
Depuis
3.0.0
Exceptions
RuntimeException

Documentation des champs

◆ $charset

$charset
protected

◆ $dateformat

$dateformat
protected

◆ $name

$name = 'oracle'

◆ $nameQuote

$nameQuote = '"'
protected

◆ $serverType

$serverType = 'oracle'

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