PHPXRef 0.7.1 : Joomla 2.5.4 DE : Detail view of sqlsrv.php

Class: JDatabaseSQLSrv - X-Ref

SQL Server database driver

test() X-Ref

Test to see if the SQLSRV connector is available.

return: boolean True on success, false otherwise.

__construct($options) X-Ref

Constructor.

param: array $options List of options used to configure the connection

__destruct() X-Ref

Destructor.

getTableConstraints($tableName) X-Ref

Get table constraints

param: string $tableName The name of the database table.
return: array Any constraints available for the table.

renameConstraints($constraints = array() X-Ref

Rename constraints.

param: array   $constraints  Array(strings) of table constraints
param: string  $prefix       A string
param: string  $backup       A string
return: void

escape($text, $extra = false) X-Ref

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: string   $text   The string to be escaped.
param: boolean  $extra  Optional parameter to provide extra escaping.
return: string  The escaped string.

connected() X-Ref

Determines if the connection to the server is active.

return: boolean True if connected to the database engine.

dropTable($tableName, $ifExists = true) X-Ref

Drops a table from the database.

param: string   $tableName  The name of the database table to drop.
param: boolean  $ifExists   Optionally specify that the table must exist before it is dropped.
return: JDatabaseSQLSrv  Returns this object to support chaining.

getAffectedRows() X-Ref

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

return: integer The number of affected rows.

getCollation() X-Ref

Method to get the database collation in use by sampling a text field of a table in the database.

return: mixed The collation in use by the database or boolean false if not supported.

getExporter() X-Ref

Gets an exporter class object.

return: JDatabaseExporterSQLAzure An exporter object.

getImporter() X-Ref

Gets an importer class object.

return: JDatabaseImporterSQLAzure An importer object.

getNumRows($cursor = null) X-Ref

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

param: resource $cursor An optional database cursor resource to extract the row count from.
return: integer The number of returned rows.

getQuery($new = false) X-Ref

Get the current or query, or new JDatabaseQuery object.

param: boolean $new False to return the last query set, True to return a new JDatabaseQuery object.
return: mixed The current value of the internal SQL variable or a new JDatabaseQuery object.

getTableColumns($table, $typeOnly = true) X-Ref

Retrieves field information about the given tables.

param: mixed    $table     A table name
param: boolean  $typeOnly  True to only return field types.
return: array  An array of fields.

getTableCreate($tables) X-Ref

Shows the table CREATE statement that creates the given tables.

This is unsupported by MSSQL.

param: mixed $tables A table name or a list of table names.
return: array A list of the create SQL for the tables.

getTableKeys($table) X-Ref

Get the details list of keys for a table.

param: string $table The name of the table.
return: array An array of the column specification for the table.

quote($text, $escape = true) X-Ref

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

param: string   $text    The string to quote.
param: boolean  $escape  True to escape the string, false to leave it unchanged.
return: string  The quoted input string.

getTableList() X-Ref

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

return: array An array of all the tables in the database.

getVersion() X-Ref

Get the version of the database connector.

return: string The database connector version.

hasUTF() X-Ref

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

return: boolean True if supported.

insertObject($table, &$object, $key = null) X-Ref

Inserts a row into a table based on an object's properties.

param: string  $table    The name of the database table to insert into.
param: object  &$object  A reference to an object whose public properties match the table fields.
param: string  $key      The name of the primary key. If provided the object property is updated.
return: boolean    True on success.

insertid() X-Ref

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

return: integer The value of the auto-increment field from the last inserted row.

loadResult() X-Ref

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

return: mixed The return value or null if the query failed.

query() X-Ref

Execute the SQL statement.

return: mixed A database cursor resource on success, boolean false on failure.

replacePrefix($sql, $prefix = ') X-Ref

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

param: string  $sql     The SQL statement to prepare.
param: string  $prefix  The common table prefix.
return: string  The processed SQL statement.

select($database) X-Ref

Select a database for use.

param: string $database The name of the database to select for use.
return: boolean True if the database was successfully selected.

setUTF() X-Ref

Set the connection to use UTF-8 character encoding.

return: boolean True on success.

transactionCommit() X-Ref

Method to commit a transaction.

return: void

transactionRollback() X-Ref

Method to roll back a transaction.

return: void

transactionStart() X-Ref

Method to initialize a transaction.

return: void

fetchArray($cursor = null) X-Ref

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

param: mixed $cursor The optional result set cursor from which to fetch the row.
return: mixed Either the next row from the result set or false if there are no more rows.

fetchAssoc($cursor = null) X-Ref

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

param: mixed $cursor The optional result set cursor from which to fetch the row.
return: mixed Either the next row from the result set or false if there are no more rows.

fetchObject($cursor = null, $class = 'stdClass') X-Ref

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

param: mixed   $cursor  The optional result set cursor from which to fetch the row.
param: string  $class   The class name to use for the returned row object.
return: mixed   Either the next row from the result set or false if there are no more rows.

freeResult($cursor = null) X-Ref

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

param: mixed $cursor The optional result set cursor from which to fetch the row.
return: void

explain() X-Ref

Diagnostic method to return explain information for a query.

return: string The explain output.

queryBatch($abortOnError = true, $transactionSafe = false) X-Ref

Execute a query batch.

param: boolean  $abortOnError     Abort on error.
param: boolean  $transactionSafe  Transaction safe queries.
return: mixed  A database resource if successful, false if not.

checkFieldExists($table, $field) X-Ref

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

param: string  $table  The table in which to verify the field.
param: string  $field  The field to verify.
return: boolean  True if the field exists in the table.

limit($sql, $limit, $offset) X-Ref

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

param: string   $sql     The SQL statement to process.
param: integer  $limit   The maximum affected rows to set.
param: integer  $offset  The affected row offset to set.
return: string   The processed SQL statement.

renameTable($oldTable, $newTable, $backup = null, $prefix = null) X-Ref

Renames a table in the database.

param: string  $oldTable  The name of the table to be renamed
param: string  $newTable  The new name for the table.
param: string  $backup    Table prefix
param: string  $prefix    For the table - used to rename constraints in non-mysql databases
return: JDatabase  Returns this object to support chaining.

lockTable($tableName) X-Ref

Locks a table in the database.

param: string $tableName The name of the table to lock.
return: JDatabase Returns this object to support chaining.

unlockTables() X-Ref

Unlocks tables in the database.

return: JDatabase Returns this object to support chaining.

Copyright:	Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
License:	GNU General Public License version 2 or later; see LICENSE
File Size:	1182 lines (28 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of Joomla 2.5.4 DE

/libraries/joomla/database/database/ -> sqlsrv.php (summary)

Defines 1 class