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

Liste de tous les membres

Fonctions membres publiques

 __construct ($options)
 __destruct ()
 connect ()
 disconnect ()
 dropTable ($tableName, $ifExists=true)
 getCollation ()
 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)
- Fonctions membres publiques inherited from JDatabaseDriverPdo
 escape ($text, $extra=false)
 execute ()
 getOption ($key)
 setOption ($key, $value)
 connected ()
 getAffectedRows ()
 getNumRows ($cursor=null)
 insertid ()
 setQuery ($query, $offset=null, $limit=null, $driverOptions=array())
 loadNextObject ($class= 'stdClass')
 loadNextAssoc ()
 loadNextRow ()
 __sleep ()
 __wakeup ()
- Fonctions membres publiques inherited from JDatabaseDriver
 __call ($method, $args)
 alterDbCharacterSet ($dbName)
 createDatabase ($options, $utf=true)
 addDisconnectHandler ($callable)
 getConnection ()
 getCount ()
 getLog ()
 getTimings ()
 getCallStacks ()
 getMinimum ()
 getNullDate ()
 getPrefix ()
 getExporter ()
 getImporter ()
 getQuery ($new=false)
 getIterator ($column=null, $class= 'stdClass')
 getTableList ()
 getUTFSupport ()
 hasUTFSupport ()
 insertObject ($table, &$object, $key=null)
 isMinimumVersion ()
 loadAssoc ()
 loadAssocList ($key=null, $column=null)
 loadColumn ($offset=0)
 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)
 updateObject ($table, &$object, $key, $nulls=false)
- Fonctions membres publiques inherited from JDatabase
 query ()
 getErrorMsg ($escaped=false)
 getErrorNum ()
 stderr ($showSQL=false)

Fonctions membres publiques statiques

static isSupported ()

Attributs publics

 $name = 'oracle'
- Attributs publics inherited from JDatabaseDriverPdo
- Attributs publics inherited from JDatabaseDriver

Attributs protégés

 $nameQuote = '"'
 $dateformat
 $charset
- Attributs protégés inherited from JDatabaseDriverPdo
 $nullDate = '0000-00-00 00:00:00'
 $prepared
 $executed = false
- 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()

Additional Inherited Members

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

Description détaillée

Définition à la ligne 20 du fichier oracle.php.

Documentation des constructeurs et destructeur

JDatabaseDriverOracle::__construct (   $options)

Constructor.

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

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

Définition à la ligne 64 du fichier oracle.php.

{
$options['driver'] = 'oci';
$options['charset'] = (isset($options['charset'])) ? $options['charset'] : 'AL32UTF8';
$options['dateformat'] = (isset($options['dateformat'])) ? $options['dateformat'] : 'RRRR-MM-DD HH24:MI:SS';
$this->charset = $options['charset'];
$this->dateformat = $options['dateformat'];
// Finalize initialisation
parent::__construct($options);
}
JDatabaseDriverOracle::__destruct ( )

Destructor.

Depuis:
12.1

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

Définition à la ligne 82 du fichier oracle.php.

{
$this->freeResult();
unset($this->connection);
}

Documentation des fonctions membres

JDatabaseDriverOracle::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 JDatabaseDriverPdo.

Définition à la ligne 96 du fichier oracle.php.

{
if ($this->connection)
{
return;
}
parent::connect();
if (isset($this->options['schema']))
{
$this->setQuery('ALTER SESSION SET CURRENT_SCHEMA = ' . $this->quoteName($this->options['schema']))->execute();
}
$this->setDateFormat($this->dateformat);
}
JDatabaseDriverOracle::disconnect ( )

Disconnects the database.

Renvoie:
void
Depuis:
12.1

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

Définition à la ligne 120 du fichier oracle.php.

{
// Close the connection.
$this->freeResult();
unset($this->connection);
}
JDatabaseDriverOracle::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:
12.1

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

Définition à la ligne 139 du fichier oracle.php.

{
$this->connect();
$query = $this->getQuery(true)
->setQuery('DROP TABLE :tableName');
$query->bind(':tableName', $tableName);
$this->setQuery($query);
$this->execute();
return $this;
}
JDatabaseDriverOracle::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

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

Définition à la ligne 161 du fichier oracle.php.

{
return $this->charset;
}
JDatabaseDriverOracle::getConnectedQuery ( )

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

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

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

Définition à la ligne 173 du fichier oracle.php.

{
return 'SELECT 1 FROM dual';
}
JDatabaseDriverOracle::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:
12.1

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

Définition à la ligne 189 du fichier oracle.php.

{
return $this->dateformat;
}
JDatabaseDriverOracle::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 241 du fichier oracle.php.

{
$this->connect();
$columns = array();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->select('*');
$query->from('ALL_TAB_COLUMNS');
$query->where('table_name = :tableName');
$prefixedTable = str_replace('#__', strtoupper($this->tablePrefix), $table);
$query->bind(':tableName', $prefixedTable);
$this->setQuery($query);
$fields = $this->loadObjectList();
if ($typeOnly)
{
foreach ($fields as $field)
{
$columns[$field->COLUMN_NAME] = $field->DATA_TYPE;
}
}
else
{
foreach ($fields as $field)
{
$columns[$field->COLUMN_NAME] = $field;
$columns[$field->COLUMN_NAME]->Default = null;
}
}
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $columns;
}
JDatabaseDriverOracle::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:
12.1
Exceptions:
RuntimeException

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

Définition à la ligne 207 du fichier oracle.php.

{
$this->connect();
$result = array();
$query = $this->getQuery(true)
->select('dbms_metadata.get_ddl(:type, :tableName)')
->from('dual')
->bind(':type', 'TABLE');
// Sanitize input to an array and iterate over the list.
settype($tables, 'array');
foreach ($tables as $table)
{
$query->bind(':tableName', $table);
$this->setQuery($query);
$statement = (string) $this->loadResult();
$result[$table] = $statement;
}
return $result;
}
JDatabaseDriverOracle::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 294 du fichier oracle.php.

{
$this->connect();
$query = $this->getQuery(true);
$fieldCasing = $this->getOption(PDO::ATTR_CASE);
$this->setOption(PDO::ATTR_CASE, PDO::CASE_UPPER);
$table = strtoupper($table);
$query->select('*')
->from('ALL_CONSTRAINTS')
->where('table_name = :tableName')
->bind(':tableName', $table);
$this->setQuery($query);
$keys = $this->loadObjectList();
$this->setOption(PDO::ATTR_CASE, $fieldCasing);
return $keys;
}
JDatabaseDriverOracle::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:
12.1
Exceptions:
RuntimeException

Définition à la ligne 329 du fichier oracle.php.

{
$this->connect();
$query = $this->getQuery(true);
if ($includeDatabaseName)
{
$query->select('owner, table_name');
}
else
{
$query->select('table_name');
}
$query->from('all_tables');
if ($databaseName)
{
$query->where('owner = :database')
->bind(':database', $databaseName);
}
$query->order('table_name');
$this->setQuery($query);
if ($includeDatabaseName)
{
$tables = $this->loadAssocList();
}
else
{
$tables = $this->loadColumn();
}
return $tables;
}
JDatabaseDriverOracle::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 374 du fichier oracle.php.

{
$this->connect();
$this->setQuery("select value from nls_database_parameters where parameter = 'NLS_RDBMS_VERSION'");
return $this->loadResult();
}
static JDatabaseDriverOracle::isSupported ( )
static

Test to see if the PDO ODBC connector is available.

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

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

Définition à la ligne 511 du fichier oracle.php.

{
return class_exists('PDO') && in_array('oci', PDO::getAvailableDrivers());
}
JDatabaseDriverOracle::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:
12.1
Exceptions:
RuntimeException

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

Définition à la ligne 462 du fichier oracle.php.

{
$this->setQuery('LOCK TABLE ' . $this->quoteName($table) . ' IN EXCLUSIVE MODE')->execute();
return $this;
}
JDatabaseDriverOracle::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:
12.1
Exceptions:
RuntimeException

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

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

{
$this->setQuery('RENAME ' . $oldTable . ' TO ' . $newTable)->execute();
return $this;
}
JDatabaseDriverOracle::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:
11.1

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

Définition à la ligne 527 du fichier oracle.php.

{
$startPos = 0;
$quoteChar = "'";
$literal = '';
$query = trim($query);
$n = strlen($query);
while ($startPos < $n)
{
$ip = strpos($query, $prefix, $startPos);
if ($ip === false)
{
break;
}
$j = strpos($query, "'", $startPos);
if ($j === false)
{
$j = $n;
}
$literal .= str_replace($prefix, $this->tablePrefix, substr($query, $startPos, $j - $startPos));
$startPos = $j;
$j = $startPos + 1;
if ($j >= $n)
{
break;
}
// Quote comes first, find end of quote
while (true)
{
$k = strpos($query, $quoteChar, $j);
$escaped = false;
if ($k === false)
{
break;
}
$l = $k - 1;
while ($l >= 0 && $query{$l} == '\\')
{
$l--;
$escaped = !$escaped;
}
if ($escaped)
{
$j = $k + 1;
continue;
}
break;
}
if ($k === false)
{
// Error in the query - no end quote; ignore it
break;
}
$literal .= substr($query, $startPos, $k - $startPos + 1);
$startPos = $k + 1;
}
if ($startPos < $n)
{
$literal .= substr($query, $startPos, $n - $startPos);
}
return $literal;
}
JDatabaseDriverOracle::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:
12.1
Exceptions:
RuntimeException

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

Définition à la ligne 393 du fichier oracle.php.

{
$this->connect();
return true;
}
JDatabaseDriverOracle::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:
12.1

Définition à la ligne 414 du fichier oracle.php.

{
$this->connect();
$this->setQuery("ALTER SESSION SET NLS_DATE_FORMAT = '$dateFormat'");
if (!$this->execute())
{
return false;
}
$this->setQuery("ALTER SESSION SET NLS_TIMESTAMP_FORMAT = '$dateFormat'");
if (!$this->execute())
{
return false;
}
$this->dateformat = $dateFormat;
return true;
}
JDatabaseDriverOracle::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:
12.1

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

Définition à la ligne 447 du fichier oracle.php.

{
return false;
}
JDatabaseDriverOracle::transactionCommit (   $toSavepoint = false)

Method to commit a transaction.

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

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

Définition à la ligne 609 du fichier oracle.php.

{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionCommit($toSavepoint);
}
else
{
$this->transactionDepth--;
}
}
JDatabaseDriverOracle::transactionRollback (   $toSavepoint = false)

Method to roll back a transaction.

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

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

Définition à la ligne 633 du fichier oracle.php.

{
$this->connect();
if (!$toSavepoint || $this->transactionDepth <= 1)
{
parent::transactionRollback($toSavepoint);
}
else
{
$savepoint = 'SP_' . ($this->transactionDepth - 1);
$this->setQuery('ROLLBACK TO SAVEPOINT ' . $this->quoteName($savepoint));
if ($this->execute())
{
$this->transactionDepth--;
}
}
}
JDatabaseDriverOracle::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.3
Exceptions:
RuntimeException

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

Définition à la ligne 663 du fichier oracle.php.

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

Unlocks tables in the database.

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

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

Définition à la ligne 497 du fichier oracle.php.

{
$this->setQuery('COMMIT')->execute();
return $this;
}

Documentation des données membres

JDatabaseDriverOracle::$charset
protected

Définition à la ligne 55 du fichier oracle.php.

JDatabaseDriverOracle::$dateformat
protected

Définition à la ligne 47 du fichier oracle.php.

JDatabaseDriverOracle::$name = 'oracle'

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

Définition à la ligne 28 du fichier oracle.php.

JDatabaseDriverOracle::$nameQuote = '"'
protected

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

Définition à la ligne 39 du fichier oracle.php.

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