Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JDatabaseSQLSrv
+ Graphe d'héritage de JDatabaseSQLSrv:
+ Graphe de collaboration de JDatabaseSQLSrv:

Liste de tous les membres

Fonctions membres publiques

 __destruct ()
 escape ($text, $extra=false)
 connected ()
 dropTable ($tableName, $ifExists=true)
 getAffectedRows ()
 getCollation ()
 getExporter ()
 getImporter ()
 getNumRows ($cursor=null)
 getQuery ($new=false)
 getTableColumns ($table, $typeOnly=true)
 getTableCreate ($tables)
 getTableKeys ($table)
 quote ($text, $escape=true)
 getTableList ()
 getVersion ()
 hasUTF ()
 insertObject ($table, &$object, $key=null)
 insertid ()
 loadResult ()
 execute ()
 replacePrefix ($sql, $prefix= '#__')
 select ($database)
 setUTF ()
 transactionCommit ()
 transactionRollback ()
 transactionStart ()
 explain ()
 queryBatch ($abortOnError=true, $transactionSafe=false)
 renameTable ($oldTable, $newTable, $backup=null, $prefix=null)
 lockTable ($tableName)
 unlockTables ()
- Fonctions membres publiques inherited from JDatabase
 __call ($method, $args)
 addQuoted ($quoted)
 getConnection ()
 getCount ()
 getDateFormat ()
 getLimit ()
 getLog ()
 getMinimum ()
 getNullDate ()
 getOffset ()
 getPrefix ()
 getUTFSupport ()
 isMinimumVersion ()
 loadAssoc ()
 loadAssocList ($key=null, $column=null)
 loadColumn ($offset=0)
 loadNextObject ($class= 'stdClass')
 loadNextRow ()
 loadObject ($class= 'stdClass')
 loadObjectList ($key= '', $class= 'stdClass')
 loadRow ()
 loadRowList ($key=null)
 query ()
 quoteName ($name, $as=null)
 setDebug ($level)
 setQuery ($query, $offset=0, $limit=0)
 truncateTable ($table)
 updateObject ($table, &$object, $key, $nulls=false)
 debug ($level)
 getErrorMsg ($escaped=false)
 getErrorNum ()
 getEscaped ($text, $extra=false)
 getTableFields ($tables, $typeOnly=true)
 getTicker ()
 isQuoted ($field)
 loadResultArray ($offset=0)
 nameQuote ($name)
 stderr ($showSQL=false)

Fonctions membres publiques statiques

static test ()
- Fonctions membres publiques statiques inherited from JDatabase
static getConnectors ()
static getInstance ($options=array())
static splitSql ($sql)

Attributs publics

 $name = 'sqlsrv'
- Attributs publics inherited from JDatabase

Fonctions membres protégées

 __construct ($options)
 getTableConstraints ($tableName)
 renameConstraints ($constraints=array(), $prefix=null, $backup=null)
 fetchArray ($cursor=null)
 fetchAssoc ($cursor=null)
 fetchObject ($cursor=null, $class= 'stdClass')
 freeResult ($cursor=null)
 checkFieldExists ($table, $field)
 limit ($sql, $limit, $offset)
- Fonctions membres protégées inherited from JDatabase
 getDatabase ()
 quoteNameStr ($strArr)

Attributs protégés

 $nameQuote = '[]'
 $nullDate = '1900-01-01 00:00:00'
 $dbMinimum = '10.50.1600.1'
- Attributs protégés inherited from JDatabase
 $connection
 $count = 0
 $cursor
 $debug = false
 $limit = 0
 $log = array()
 $offset = 0
 $sql
 $tablePrefix
 $utf = true
 $errorNum = 0
 $errorMsg
 $hasQuoted = false
 $quoted = array()

Additional Inherited Members

- Attributs protégés statiques inherited from JDatabase
static $instances = array()

Documentation des constructeurs et destructeur

JDatabaseSQLSrv::__construct (   $options)
protected

Constructor.

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

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

Références $config, JError\$legacy, $options, et JText\_().

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::__destruct ( )

Destructor.

Depuis:
11.1

Documentation des fonctions membres

JDatabaseSQLSrv::checkFieldExists (   $table,
  $field 
)
protected

Method to check and see if a field exists in a table.

Paramètres:
string$tableThe table in which to verify the field.
string$fieldThe field to verify.
Renvoie:
boolean True if the field exists in the table.
Depuis:
11.1
JDatabaseSQLSrv::connected ( )

Determines if the connection to the server is active.

Renvoie:
boolean True if connected to the database engine.
Depuis:
11.1

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

JDatabaseSQLSrv::dropTable (   $tableName,
  $ifExists = true 
)

Drops a table from the database.

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

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

Références $query.

JDatabaseSQLSrv::escape (   $text,
  $extra = false 
)

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

The escaping for MSSQL isn't handled in the driver though that would be nice. Because of this we need to handle the escaping ourselves.

Paramètres:
string$textThe string to be escaped.
boolean$extraOptional parameter to provide extra escaping.
Renvoie:
string The escaped string.
Depuis:
11.1

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

Références $text.

JDatabaseSQLSrv::execute ( )

Execute the SQL statement.

Renvoie:
mixed A database cursor resource on success, boolean false on failure.
Depuis:
11.1
Exceptions:
JDatabaseException

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

Références JError\$legacy, JLog\add(), JLog\DEBUG, JLog\ERROR, JError\raiseError(), et JText\sprintf().

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::explain ( )

Diagnostic method to return explain information for a query.

Renvoie:
string The explain output.
Obsolète:
12.1
Voir également:
http://msdn.microsoft.com/en-us/library/aa259203%28SQL.80%29.aspx
Depuis:
11.1

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

Références $row, JLog\add(), null, et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::fetchArray (   $cursor = null)
protected

Method to fetch a row from the result set cursor as an array.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
11.1

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

JDatabaseSQLSrv::fetchAssoc (   $cursor = null)
protected

Method to fetch a row from the result set cursor as an associative array.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
11.1

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

JDatabaseSQLSrv::fetchObject (   $cursor = null,
  $class = 'stdClass' 
)
protected

Method to fetch a row from the result set cursor as an object.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
string$classThe class name to use for the returned row object.
Renvoie:
mixed Either the next row from the result set or false if there are no more rows.
Depuis:
11.1

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

Références $class.

JDatabaseSQLSrv::freeResult (   $cursor = null)
protected

Method to free up the memory used for the result set.

Paramètres:
mixed$cursorThe optional result set cursor from which to fetch the row.
Renvoie:
void
Depuis:
11.1

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

JDatabaseSQLSrv::getAffectedRows ( )

Get the number of affected rows for the previous executed SQL statement.

Renvoie:
integer The number of affected rows.
Depuis:
11.1

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

JDatabaseSQLSrv::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:
11.1

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

JDatabaseSQLSrv::getExporter ( )

Gets an exporter class object.

Renvoie:
JDatabaseExporterSQLAzure An exporter object.
Depuis:
11.1
Exceptions:
JDatabaseException

Références JText\_().

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::getImporter ( )

Gets an importer class object.

Renvoie:
JDatabaseImporterSQLAzure An importer object.
Depuis:
11.1
Exceptions:
JDatabaseException

Références JText\_().

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::getNumRows (   $cursor = null)

Get the number of returned rows for the previous executed SQL statement.

Paramètres:
resource$cursorAn optional database cursor resource to extract the row count from.
Renvoie:
integer The number of returned rows.
Depuis:
11.1

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

JDatabaseSQLSrv::getQuery (   $new = false)

Get the current or query, or new JDatabaseQuery object.

Paramètres:
boolean$newFalse to return the last query set, True to return a new JDatabaseQuery object.
Renvoie:
mixed The current value of the internal SQL variable or a new JDatabaseQuery object.
Depuis:
11.1
Exceptions:
JDatabaseException

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

Réimplémentée dans JDatabaseSQLAzure.

Références JText\_().

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::getTableColumns (   $table,
  $typeOnly = true 
)

Retrieves field information about the given tables.

Paramètres:
mixed$tableA table name
boolean$typeOnlyTrue to only return field types.
Renvoie:
array An array of fields.
Depuis:
11.1
Exceptions:
JDatabaseException

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

Références $field, et $fields.

JDatabaseSQLSrv::getTableConstraints (   $tableName)
protected

Get table constraints

Paramètres:
string$tableNameThe name of the database table.
Renvoie:
array Any constraints available for the table.
Depuis:
11.1

Références $query.

JDatabaseSQLSrv::getTableCreate (   $tables)

Shows the table CREATE statement that creates the given tables.

This is unsupported by MSSQL.

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

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

JDatabaseSQLSrv::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:
11.1
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::getTableList ( )

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

Renvoie:
array An array of all the tables in the database.
Depuis:
11.1
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::getVersion ( )

Get the version of the database connector.

Renvoie:
string The database connector version.
Depuis:
11.1

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

Références $version.

JDatabaseSQLSrv::hasUTF ( )

Determines if the database engine supports UTF-8 character encoding.

Renvoie:
boolean True if supported.
Depuis:
11.1

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

JDatabaseSQLSrv::insertid ( )

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

Renvoie:
integer The value of the auto-increment field from the last inserted row.
Depuis:
11.1

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

JDatabaseSQLSrv::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:
11.1
Exceptions:
JDatabaseException

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

Références $fields, $id, et $key.

JDatabaseSQLSrv::limit (   $sql,
  $limit,
  $offset 
)
protected

Method to wrap an SQL statement to provide a LIMIT and OFFSET behavior for scrolling through a result set.

Paramètres:
string$sqlThe SQL statement to process.
integer$limitThe maximum affected rows to set.
integer$offsetThe affected row offset to set.
Renvoie:
string The processed SQL statement.
Depuis:
11.1

Références $limit.

JDatabaseSQLSrv::loadResult ( )

Method to get the first field of the first row of the result set from the database query.

Renvoie:
mixed The return value or null if the query failed.
Depuis:
11.1
Exceptions:
JDatabaseException

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

Références $row, et null.

JDatabaseSQLSrv::lockTable (   $tableName)

Locks a table in the database.

Paramètres:
string$tableNameThe name of the table to lock.
Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::queryBatch (   $abortOnError = true,
  $transactionSafe = false 
)

Execute a query batch.

Paramètres:
boolean$abortOnErrorAbort on error.
boolean$transactionSafeTransaction safe queries.
Renvoie:
mixed A database resource if successful, false if not.
Depuis:
11.1
Obsolète:
12.1

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

Références $query, JLog\add(), null, et JLog\WARNING.

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::quote (   $text,
  $escape = true 
)

Method to quote and optionally escape a string to database requirements for insertion into the database.

Paramètres:
string$textThe string to quote.
boolean$escapeTrue to escape the string, false to leave it unchanged.
Renvoie:
string The quoted input string.
Depuis:
11.1

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

Références $text.

JDatabaseSQLSrv::renameConstraints (   $constraints = array(),
  $prefix = null,
  $backup = null 
)
protected

Rename constraints.

Paramètres:
array$constraintsArray(strings) of table constraints
string$prefixA string
string$backupA string
Renvoie:
void
Depuis:
11.1
JDatabaseSQLSrv::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$backupTable prefix
string$prefixFor the table - used to rename constraints in non-mysql databases
Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

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

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

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

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

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

Références $n.

JDatabaseSQLSrv::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:
11.1
Exceptions:
JDatabaseException

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

Références JError\$legacy, JText\_(), et null.

+ Voici le graphe d'appel pour cette fonction :

JDatabaseSQLSrv::setUTF ( )

Set the connection to use UTF-8 character encoding.

Renvoie:
boolean True on success.
Depuis:
11.1

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

static JDatabaseSQLSrv::test ( )
static

Test to see if the SQLSRV connector is available.

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

Implémente JDatabaseInterface.

JDatabaseSQLSrv::transactionCommit ( )

Method to commit a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::transactionRollback ( )

Method to roll back a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::transactionStart ( )

Method to initialize a transaction.

Renvoie:
void
Depuis:
11.1
Exceptions:
JDatabaseException

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

JDatabaseSQLSrv::unlockTables ( )

Unlocks tables in the database.

Renvoie:
JDatabase Returns this object to support chaining.
Depuis:
11.4
Exceptions:
JDatabaseException

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


Documentation des données membres

JDatabaseSQLSrv::$dbMinimum = '10.50.1600.1'
protected

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

JDatabaseSQLSrv::$name = 'sqlsrv'

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

Réimplémentée dans JDatabaseSQLAzure.

JDatabaseSQLSrv::$nameQuote = '[]'
protected

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

JDatabaseSQLSrv::$nullDate = '1900-01-01 00:00:00'
protected

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


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