Docs For Class JDatabaseQueryOracle

Description

Implements interfaces:

Oracle Query Building Class.

since: 12.1

Located in /libraries/joomla/database/query/oracle.php (line 19)

JDatabaseQuery
   |
   --JDatabaseQueryPdo
      |
      --JDatabaseQueryOracle

Variable Summary

array $bounded

integer $limit

integer $offset

Method Summary

JDatabaseQueryOracle bind ([string|integer $key = null], [mixed &$value = null], [integer $dataType = PDO::PARAM_STR], [integer $length = 0], [array $driverOptions = array()])

JDatabaseQueryOracle clear ([string $clause = null])

mixed &getBounded ([mixed $key = null])

string processLimit (string $query, integer $limit, [integer $offset = 0])

JDatabaseQueryOracle setLimit ([integer $limit = 0], [integer $offset = 0])

Variables

array $bounded = array() (line 37)

var: Bounded object array
since: 12.1
access: protected

integer $limit (line 31)

var: The limit for the result set.
since: 12.1
access: protected

integer $offset (line 25)

var: The offset for the result set.
since: 12.1
access: protected

Inherited Variables

Inherited from JDatabaseQuery

JDatabaseQuery::$autoIncrementField
JDatabaseQuery::$call
JDatabaseQuery::$columns
JDatabaseQuery::$db
JDatabaseQuery::$delete
JDatabaseQuery::$element
JDatabaseQuery::$exec
JDatabaseQuery::$from
JDatabaseQuery::$group
JDatabaseQuery::$having
JDatabaseQuery::$insert
JDatabaseQuery::$join
JDatabaseQuery::$order
JDatabaseQuery::$select
JDatabaseQuery::$set
JDatabaseQuery::$sql
JDatabaseQuery::$type
JDatabaseQuery::$union
JDatabaseQuery::$unionAll
JDatabaseQuery::$update
JDatabaseQuery::$values
JDatabaseQuery::$where

Methods

bind (line 55)

Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also removes a variable that has been bounded from the internal bounded array when the passed in value is null.

since: 12.1
access: public

JDatabaseQueryOracle bind ([string|integer $key = null], [mixed &$value = null], [integer $dataType = PDO::PARAM_STR], [integer $length = 0], [array $driverOptions = array()])

string|integer $key: The key that will be used in your SQL query to reference the value. Usually of the form ':key', but can also be an integer.
mixed &$value: The value that will be bound. The value is passed by reference to support output parameters such as those possible with stored procedures.
integer $dataType: Constant corresponding to a SQL datatype.
integer $length: The length of the variable. Usually required for OUTPUT parameters.
array $driverOptions: Optional driver options to be used.

Implementation of:

JDatabaseQueryPreparable::bind(): Method to add a variable to an internal array that will be bound to a prepared SQL statement before query execution. Also removes a variable that has been bounded from the internal bounded array when the passed in value is null.

clear (line 123)

Clear data from the query or a specific clause of the query.

return: Returns this object to allow chaining.
since: 12.1
access: public

JDatabaseQueryOracle clear ([string $clause = null])

string $clause: Optionally, the name of the clause to clear, or nothing to clear the whole query.

Redefinition of:

JDatabaseQuery::clear(): Clear data from the query or a specific clause of the query.

getBounded (line 99)

Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is returned.

since: 12.1
access: public

mixed &getBounded ([mixed $key = null])

mixed $key: The bounded variable key to retrieve.

Implementation of:

JDatabaseQueryPreparable::getBounded(): Retrieves the bound parameters array when key is null and returns it by reference. If a key is provided then that item is returned.

processLimit (line 152)

Method to modify a query already in string format with the needed

additions to make the query limited to a particular number of results, or start at a particular offset. This method is used automatically by the __toString() method if it detects that the query implements the JDatabaseQueryLimitable interface.

since: 12.1
access: public

string processLimit (string $query, integer $limit, [integer $offset = 0])

string $query: The query in string format
integer $limit: The limit for the result set
integer $offset: The offset for the result set

Implementation of:

JDatabaseQueryLimitable::processLimit(): Method to modify a query already in string format with the needed

setLimit (line 197)

Sets the offset and limit for the result set, if the database driver supports it.

Usage: $query->setLimit(100, 0); (retrieve 100 rows, starting at first record) $query->setLimit(50, 50); (retrieve 50 rows, starting at 50th record)

return: Returns this object to allow chaining.
since: 12.1
access: public

JDatabaseQueryOracle setLimit ([integer $limit = 0], [integer $offset = 0])

integer $limit: The limit for the result set
integer $offset: The offset for the result set

Implementation of:

JDatabaseQueryLimitable::setLimit(): Sets the offset and limit for the result set, if the database driver supports it.

Inherited Methods

Inherited From JDatabaseQuery

JDatabaseQuery::__construct()
JDatabaseQuery::call()
JDatabaseQuery::castAsChar()
JDatabaseQuery::charLength()
JDatabaseQuery::clear()
JDatabaseQuery::columns()
JDatabaseQuery::concatenate()
JDatabaseQuery::currentTimestamp()
JDatabaseQuery::dateAdd()
JDatabaseQuery::dateFormat()
JDatabaseQuery::day()
JDatabaseQuery::delete()
JDatabaseQuery::dump()
JDatabaseQuery::escape()
JDatabaseQuery::exec()
JDatabaseQuery::format()
JDatabaseQuery::from()
JDatabaseQuery::group()
JDatabaseQuery::having()
JDatabaseQuery::hour()
JDatabaseQuery::innerJoin()
JDatabaseQuery::insert()
JDatabaseQuery::join()
JDatabaseQuery::leftJoin()
JDatabaseQuery::length()
JDatabaseQuery::minute()
JDatabaseQuery::month()
JDatabaseQuery::nullDate()
JDatabaseQuery::order()
JDatabaseQuery::outerJoin()
JDatabaseQuery::quote()
JDatabaseQuery::quoteName()
JDatabaseQuery::rightJoin()
JDatabaseQuery::second()
JDatabaseQuery::select()
JDatabaseQuery::set()
JDatabaseQuery::setQuery()
JDatabaseQuery::union()
JDatabaseQuery::unionAll()
JDatabaseQuery::unionDistinct()
JDatabaseQuery::update()
JDatabaseQuery::values()
JDatabaseQuery::where()
JDatabaseQuery::year()
JDatabaseQuery::__call()
JDatabaseQuery::__clone()
JDatabaseQuery::__get()
JDatabaseQuery::__toString()