API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

Référence de la classe JDatabase

Graphe d'héritage de JDatabase:
Graphe de collaboration de JDatabase:

Liste de tous les membres

Fonctions membres publiques

Fonctions membres publiques statiques

Attributs publics


Documentation des constructeurs et destructeur

JDatabase::__construct ( options)

Database object constructor

public

Paramètres:
arrayList of options used to configure the connection
Depuis:
1.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::__destruct ( )

Database object destructor

private

Renvoie:
boolean
Depuis:
1.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.


Documentation des fonctions membres

JDatabase::addQuoted ( quoted)

Adds a field or array of field names to the list that are to be quoted

public

Paramètres:
mixedField name or array of names
Depuis:
1.5
JDatabase::BeginTrans ( )

ADODB compatability function

Depuis:
1.5
JDatabase::CommitTrans ( )

ADODB compatability function

Depuis:
1.5
JDatabase::connected ( )

Determines if the connection to the server is active.

public

Renvoie:
boolean
Depuis:
1.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::debug ( level)

Sets the debug level on or off

public

Paramètres:
int0 = off, 1 = on
JDatabase::ErrorMsg ( )

ADODB compatability function

Depuis:
1.5
JDatabase::ErrorNo ( )

ADODB compatability function

Depuis:
1.5
JDatabase::Execute ( query)

ADODB compatability function

public

Paramètres:
stringSQL
Renvoie:
object
Depuis:
1.5

Références $query, et jimport().

Voici le graphe d'appel pour cette fonction :

JDatabase::explain ( )

Diagnostic function

public

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::GenID ( foo1 = null,
foo2 = null 
)

ADODB compatability function

Depuis:
1.5
JDatabase::getAffectedRows ( )

Get the affected rows by the most recent query

public

Renvoie:
int The number of affected rows in the previous operation
Depuis:
1.0.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::GetCol ( query)

ADODB compatability function

public

Paramètres:
stringSQL
Depuis:
1.5

Références $query.

JDatabase::getCollation ( )

Get the database collation

public

Renvoie:
string Collation in use

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getConnectors ( )

Get the database connectors

public

Renvoie:
array An array of available session handlers

Références $class, $name, JFolder::files(), et jimport().

Voici le graphe d'appel pour cette fonction :

JDatabase::getErrorMsg ( escaped = false)

Get the error message

public

Renvoie:
string The error message for the most recent query
JDatabase::getErrorNum ( )

Get the error number

public

Renvoie:
int The error number for the most recent query
JDatabase::getEscaped ( text,
extra = false 
)

Get a database escaped string

Paramètres:
stringThe string to be escaped
booleanOptional parameter to provide extra escaping
Renvoie:
string public

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

& JDatabase::getInstance ( options = array())

Returns a reference to the global Database object, only creating it if it doesn't already exist.

The 'driver' entry in the parameters array specifies the database driver to be used (defaults to 'mysql' if omitted). All other parameters are database driver dependent.

Paramètres:
arrayParameters to be passed to the database driver
Renvoie:
JDatabase A database object
Depuis:
1.5

Références $error, $path, JError::raiseError(), et JError::setErrorHandling().

Référencé par JFactory::_createDBO(), et JInstallationHelper::getDBO().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JDatabase::getLog ( )

Get a database error log

public

Renvoie:
array
JDatabase::getNullDate ( )

Get the database null date

public

Renvoie:
string Quoted null/zero date string
JDatabase::getNumRows ( cur = null)

Get the number of rows returned by the most recent query

public

Paramètres:
objectDatabase resource
Renvoie:
int The number of rows

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::GetOne ( query)

ADODB compatability function

public

Paramètres:
stringSQL
Renvoie:
mixed
Depuis:
1.5

Références $query.

JDatabase::getPrefix ( )

Get the database table prefix

public

Renvoie:
string The database prefix
JDatabase::getQuery ( )

Get the active query

public

Renvoie:
string The current value of the internal SQL vairable
JDatabase::GetRow ( query)

ADODB compatability function

public

Paramètres:
stringSQL
Renvoie:
array
Depuis:
1.5

Références $query.

JDatabase::getTableCreate ( tables)

Shows the CREATE TABLE statement that creates the given tables

public

Paramètres:
array|stringA table name or a list of table names
Renvoie:
array A list the create SQL for the tables

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getTableFields ( tables,
typeonly = true 
)

Retrieves information about the given tables

public

Paramètres:
array|stringA table name or a list of table names
booleanOnly return field types, default true
Renvoie:
array An array of fields by table

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getTableList ( )

List tables in a database

public

Renvoie:
array A list of all the tables in the database

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::getTicker ( )

Get the total number of queries made

public

Renvoie:
array
JDatabase::getUTFSupport ( )

Get the database UTF-8 support

public

Renvoie:
boolean
Depuis:
1.5
JDatabase::getVersion ( )

Get the version of the database connector

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::hasUTF ( )

Determines UTF support

public

Renvoie:
boolean
Depuis:
1.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::insertid ( )

Get the ID generated from the previous INSERT operation

public

Renvoie:
mixed

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::insertObject ( table,
&$  object,
keyName = NULL 
)

Inserts a row into a table based on an objects properties

Paramètres:
stringThe name of the table
objectAn object whose properties match table fields
stringThe name of the primary key. If provided the object property is updated.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::isQuoted ( fieldName)

Checks if field name needs to be quoted

public

Paramètres:
stringThe field name
Renvoie:
bool
JDatabase::loadAssoc ( )

Fetch a result row as an associative array

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadAssocList ( key = '')

Load a associactive list of database rows

public

Paramètres:
stringThe field name of a primary key
Renvoie:
array If key is empty as sequential list of returned records.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadObject ( )

This global function loads the first row of a query into an object

public

Paramètres:
object

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadObjectList ( key = '')

Load a list of database objects

public

Paramètres:
stringThe field name of a primary key
Renvoie:
array If key is empty as sequential list of returned records.

If key is not empty then the returned array is indexed by the value the database key. Returns null if the query fails.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadResult ( )

This method loads the first field of the first row returned by the query.

public

Renvoie:
The value returned in the query or null if the query failed.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadResultArray ( numinarray = 0)

Load an array of single field results into an array

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadRow ( )

Load the first row returned by the query

public

Renvoie:
The first row of the query.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::loadRowList ( key = '')

Load a list of database rows (numeric column indexing)

If key is not empty then the returned array is indexed by the value the database key. Returns null if the query fails.

public

Paramètres:
stringThe field name of a primary key
Renvoie:
array

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::nameQuote ( s)

Quote an identifier name (field, table, etc)

public

Paramètres:
stringThe name
Renvoie:
string The quoted name
JDatabase::PageExecute ( sql,
nrows,
page,
inputarr = false,
secs2cache = 0 
)

ADODB compatability function

public

Depuis:
1.5

Références jimport().

Voici le graphe d'appel pour cette fonction :

JDatabase::query ( )

Execute the query

public

Renvoie:
mixed A database resource if successful, FALSE if not.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::queryBatch ( abort_on_error = true,
p_transaction_safe = false 
)

Execute a batch query

public

Renvoie:
mixed A database resource if successful, FALSE if not.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::Quote ( text,
escaped = true 
)

Get a quoted database escaped string

Paramètres:
stringA string
booleanDefault true to escape string, false to leave the string unchanged
Renvoie:
string public

Références $text.

JDatabase::replacePrefix ( sql,
prefix = '#__' 
)

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

public

Paramètres:
stringThe SQL query
stringThe common table prefix

Références $k, $l, et $n.

JDatabase::RollbackTrans ( )

ADODB compatability function

Depuis:
1.5
JDatabase::SelectLimit ( query,
count,
offset = 0 
)

ADODB compatability function

public

Depuis:
1.5

Références $count, $query, et jimport().

Voici le graphe d'appel pour cette fonction :

JDatabase::setQuery ( sql,
offset = 0,
limit = 0,
prefix = '#__' 
)

Sets the SQL query string for later execution.

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

public

Paramètres:
stringThe SQL query
stringThe offset to start selection
stringThe number of results to return
stringThe common table prefix

Références $limit.

JDatabase::setUTF ( )

Custom settings for UTF support

public

Depuis:
1.5

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::splitSql ( queries)

Splits a string of queries into an array of individual queries

public

Paramètres:
stringThe queries to split
Renvoie:
array queries

Références $i, $n, et $start.

JDatabase::stderr ( showSQL = false)

Print out an error statement

Paramètres:
booleanIf TRUE, displays the last SQL statement sent to the database
Renvoie:
string A standised error message
JDatabase::test ( ) [static]

Test to see if the MySQLi connector is available

public

Renvoie:
boolean True on success, false otherwise.

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::updateObject ( table,
&$  object,
keyName,
updateNulls = true 
)

Update an object in the database

public

Paramètres:
string
object
string
boolean

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.


Documentation des données membres

JDatabase::$_cursor = null
JDatabase::$_debug = 0
JDatabase::$_errorMsg = ''
JDatabase::$_errorNum = 0
JDatabase::$_hasQuoted = null
JDatabase::$_limit = 0
JDatabase::$_log = null
JDatabase::$_nameQuote = null

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::$_nullDate = null

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.

JDatabase::$_offset = 0
JDatabase::$_quoted = null
JDatabase::$_resource = ''
JDatabase::$_sql = ''
JDatabase::$_table_prefix = ''
JDatabase::$_ticker = 0
JDatabase::$_utf = 0
JDatabase::$name = ''

Réimplémentée dans JDatabaseMySQL, et JDatabaseMySQLi.


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