JDatabaseQueryOracle

class JDatabaseQueryOracle extends JDatabaseQueryPdo implements JDatabaseQueryPreparable, JDatabaseQueryLimitable

Oracle Query Building Class.

Methods

string
__call( string $method, array $args)

Magic method to provide method alias support for quote() and quoteName().

from JDatabaseQuery
__construct( JDatabaseDriver $db = null)

Class constructor.

from JDatabaseQuery
string
__toString()

Magic function to convert the query to a string.

from JDatabaseQuery
mixed
__get( string $name)

Magic function to get protected variable value

from JDatabaseQuery
JDatabaseQuery
call( mixed $columns)

Add a single column, or array of columns to the CALL clause of the query.

from JDatabaseQuery
string
castAsChar( string $value, string $len = null)

Casts a value to a char.

from JDatabaseQueryPdo
string
charLength( string $field, string $operator = null, string $condition = null)

Gets the number of characters in a string.

from JDatabaseQuery
JDatabaseQuery
clear( string $clause = null)

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

JDatabaseQuery
columns( mixed $columns)

Adds a column, or array of column names that would be used for an INSERT INTO statement.

from JDatabaseQuery
string
concatenate( array $values, string $separator = null)

Concatenates an array of column names or values.

from JDatabaseQuery
string
currentTimestamp()

Gets the current date and time.

from JDatabaseQuery
string
dateFormat()

Returns a PHP date() function compliant date format for the database driver.

from JDatabaseQuery
string
dump()

Creates a formatted dump of the query for debugging purposes.

from JDatabaseQuery
JDatabaseQuery
delete( string $table = null)

Add a table name to the DELETE clause of the query.

from JDatabaseQuery
string
escape( string $text, boolean $extra = false)

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

from JDatabaseQuery
JDatabaseQuery
exec( mixed $columns)

Add a single column, or array of columns to the EXEC clause of the query.

from JDatabaseQuery
JDatabaseQuery
from( mixed $tables, string $subQueryAlias = null)

Add a table to the FROM clause of the query.

from JDatabaseQuery
string
year( string $date)

Used to get a string to extract year from date column.

from JDatabaseQuery
string
month( string $date)

Used to get a string to extract month from date column.

from JDatabaseQuery
string
day( string $date)

Used to get a string to extract day from date column.

from JDatabaseQuery
string
hour( string $date)

Used to get a string to extract hour from date column.

from JDatabaseQuery
string
minute( string $date)

Used to get a string to extract minute from date column.

from JDatabaseQuery
string
second( string $date)

Used to get a string to extract seconds from date column.

from JDatabaseQuery
JDatabaseQuery
group( mixed $columns)

Add a grouping column to the GROUP clause of the query.

from JDatabaseQuery
JDatabaseQuery
having( mixed $conditions, string $glue = 'AND')

A conditions to the HAVING clause of the query.

from JDatabaseQuery
JDatabaseQuery
innerJoin( string $condition)

Add an INNER JOIN clause to the query.

from JDatabaseQuery
JDatabaseQuery
insert( mixed $table, boolean $incrementField = false)

Add a table name to the INSERT clause of the query.

from JDatabaseQuery
JDatabaseQuery
join( string $type, string $conditions)

Add a JOIN clause to the query.

from JDatabaseQuery
JDatabaseQuery
leftJoin( string $condition)

Add a LEFT JOIN clause to the query.

from JDatabaseQuery
int
length( string $value)

Get the length of a string in bytes.

from JDatabaseQuery
string
nullDate( boolean $quoted = true)

Get the null or zero representation of a timestamp for the database driver.

from JDatabaseQuery
JDatabaseQuery
order( mixed $columns)

Add an ordering column to the ORDER clause of the query.

from JDatabaseQuery
JDatabaseQuery
outerJoin( string $condition)

Add an OUTER JOIN clause to the query.

from JDatabaseQuery
string
quote( mixed $text, boolean $escape = true)

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

from JDatabaseQuery
mixed
quoteName( mixed $name, mixed $as = null)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

from JDatabaseQuery
JDatabaseQuery
rightJoin( string $condition)

Add a RIGHT JOIN clause to the query.

from JDatabaseQuery
JDatabaseQuery
select( mixed $columns)

Add a single column, or array of columns to the SELECT clause of the query.

from JDatabaseQuery
JDatabaseQuery
set( mixed $conditions, string $glue = ',')

Add a single condition string, or an array of strings to the SET clause of the query.

from JDatabaseQuery
JDatabaseQuery
setQuery( mixed $sql)

Allows a direct query to be provided to the database driver's setQuery() method, but still allow queries to have bounded variables.

from JDatabaseQuery
JDatabaseQuery
update( string $table)

Add a table name to the UPDATE clause of the query.

from JDatabaseQuery
JDatabaseQuery
values( string $values)

Adds a tuple, or array of tuples that would be used as values for an INSERT INTO statement.

from JDatabaseQuery
JDatabaseQuery
where( mixed $conditions, string $glue = 'AND')

Add a single condition, or an array of conditions to the WHERE clause of the query.

from JDatabaseQuery
JDatabaseQuery
extendWhere( string $outerGlue, mixed $conditions, string $innerGlue = 'AND')

Extend the WHERE clause with a single condition or an array of conditions, with a potentially different logical operator from the one in the current WHERE clause.

from JDatabaseQuery
JDatabaseQuery
orWhere( mixed $conditions, string $glue = 'AND')

Extend the WHERE clause with an OR and a single condition or an array of conditions.

from JDatabaseQuery
JDatabaseQuery
andWhere( mixed $conditions, string $glue = 'OR')

Extend the WHERE clause with an AND and a single condition or an array of conditions.

from JDatabaseQuery
void
__clone()

Method to provide deep copy support to nested objects and arrays when cloning.

from JDatabaseQuery
JDatabaseQuery
union( mixed $query, boolean $distinct = false, string $glue = '')

Add a query to UNION with the current query.

from JDatabaseQuery
JDatabaseQuery
unionDistinct( mixed $query, string $glue = '')

Add a query to UNION DISTINCT with the current query. Simply a proxy to union with the DISTINCT keyword.

from JDatabaseQuery
string
format( string $format)

Find and replace sprintf-like tokens in a format string.

from JDatabaseQuery
string
dateAdd( string $date, string $interval, string $datePart)

Add to the current date and time.

from JDatabaseQuery
JDatabaseQuery
unionAll( mixed $query, boolean $distinct = false, string $glue = '')

Add a query to UNION ALL with the current query.

from JDatabaseQuery
JDatabaseQuery
selectRowNumber( string $orderBy, string $orderColumnAlias)

Return the number of the current row.

from JDatabaseQuery
string
q($text, $escape = true)

Alias for quote method

from JDatabaseQuery
string
qn($name, $as = null)

Alias for quoteName method

from JDatabaseQuery
string
e($text, $extra = false)

Alias for escape method

from JDatabaseQuery
JDatabaseQuery
bind( string|integer $key = null, mixed $value = null, integer $dataType = PDO::PARAM_STR, integer $length, array $driverOptions = array())

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.

mixed
getBounded( mixed $key = null)

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

string
processLimit( string $query, integer $limit, integer $offset)

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.

JDatabaseQuery
setLimit( integer $limit, integer $offset)

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

Details

string __call( string $method, array $args)

Magic method to provide method alias support for quote() and quoteName().

Parameters

string $method The called method.
array $args The array of arguments passed to the method.

Return Value

string The aliased method's return value or null.

__construct( JDatabaseDriver $db = null)

Class constructor.

Parameters

JDatabaseDriver $db The database driver.

string __toString()

Magic function to convert the query to a string.

Return Value

string The completed query.

mixed __get( string $name)

Magic function to get protected variable value

Parameters

string $name The name of the variable.

Return Value

mixed

JDatabaseQuery call( mixed $columns)

Add a single column, or array of columns to the CALL clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query. The call method can, however, be called multiple times in the same query.

Usage: $query->call('a.')->call('b.id'); $query->call(array('a.', 'b.id'));

Parameters

mixed $columns A string or an array of field names.

Return Value

JDatabaseQuery Returns this object to allow chaining.

string castAsChar( string $value, string $len = null)

Casts a value to a char.

Ensure that the value is properly quoted before passing to the method.

Usage: $query->select($query->castAsChar('a')); $query->select($query->castAsChar('a', 40));

Parameters

string $value The value to cast as a char.
string $len The lenght of the char.

Return Value

string Returns the cast value.

string charLength( string $field, string $operator = null, string $condition = null)

Gets the number of characters in a string.

Note, use 'length' to find the number of bytes in a string.

Usage: $query->select($query->charLength('a'));

Parameters

string $field A value.
string $operator Comparison operator between charLength integer value and $condition
string $condition Integer value to compare charLength with.

Return Value

string The required char length call.

JDatabaseQuery clear( string $clause = null)

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

Parameters

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

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery columns( mixed $columns)

Adds a column, or array of column names that would be used for an INSERT INTO statement.

Parameters

mixed $columns A column name, or array of column names.

Return Value

JDatabaseQuery Returns this object to allow chaining.

string concatenate( array $values, string $separator = null)

Concatenates an array of column names or values.

Usage: $query->select($query->concatenate(array('a', 'b')));

Parameters

array $values An array of values to concatenate.
string $separator As separator to place between each value.

Return Value

string The concatenated values.

string currentTimestamp()

Gets the current date and time.

Usage: $query->where('published_up < '.$query->currentTimestamp());

Return Value

string

string dateFormat()

Returns a PHP date() function compliant date format for the database driver.

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the getDateFormat method directly.

Return Value

string The format string.

string dump()

Creates a formatted dump of the query for debugging purposes.

Usage: echo $query->dump();

Return Value

string

JDatabaseQuery delete( string $table = null)

Add a table name to the DELETE clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query.

Usage: $query->delete('#__a')->where('id = 1');

Parameters

string $table The name of the table to delete from.

Return Value

JDatabaseQuery Returns this object to allow chaining.

string escape( string $text, boolean $extra = false)

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

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the escape method directly.

Note that 'e' is an alias for this method as it is in JDatabaseDriver.

Parameters

string $text The string to be escaped.
boolean $extra Optional parameter to provide extra escaping.

Return Value

string The escaped string.

Exceptions

RuntimeException if the internal db property is not a valid object.

JDatabaseQuery exec( mixed $columns)

Add a single column, or array of columns to the EXEC clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query. The exec method can, however, be called multiple times in the same query.

Usage: $query->exec('a.')->exec('b.id'); $query->exec(array('a.', 'b.id'));

Parameters

mixed $columns A string or an array of field names.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery from( mixed $tables, string $subQueryAlias = null)

Add a table to the FROM clause of the query.

Note that while an array of tables can be provided, it is recommended you use explicit joins.

Usage: $query->select('*')->from('#__a');

Parameters

mixed $tables A string or array of table names. This can be a JDatabaseQuery object (or a child of it) when used as a subquery in FROM clause along with a value for $subQueryAlias.
string $subQueryAlias Alias used when $tables is a JDatabaseQuery.

Return Value

JDatabaseQuery Returns this object to allow chaining.

Exceptions

RuntimeException

string year( string $date)

Used to get a string to extract year from date column.

Usage: $query->select($query->year($query->quoteName('dateColumn')));

Parameters

string $date Date column containing year to be extracted.

Return Value

string Returns string to extract year from a date.

string month( string $date)

Used to get a string to extract month from date column.

Usage: $query->select($query->month($query->quoteName('dateColumn')));

Parameters

string $date Date column containing month to be extracted.

Return Value

string Returns string to extract month from a date.

string day( string $date)

Used to get a string to extract day from date column.

Usage: $query->select($query->day($query->quoteName('dateColumn')));

Parameters

string $date Date column containing day to be extracted.

Return Value

string Returns string to extract day from a date.

string hour( string $date)

Used to get a string to extract hour from date column.

Usage: $query->select($query->hour($query->quoteName('dateColumn')));

Parameters

string $date Date column containing hour to be extracted.

Return Value

string Returns string to extract hour from a date.

string minute( string $date)

Used to get a string to extract minute from date column.

Usage: $query->select($query->minute($query->quoteName('dateColumn')));

Parameters

string $date Date column containing minute to be extracted.

Return Value

string Returns string to extract minute from a date.

string second( string $date)

Used to get a string to extract seconds from date column.

Usage: $query->select($query->second($query->quoteName('dateColumn')));

Parameters

string $date Date column containing second to be extracted.

Return Value

string Returns string to extract second from a date.

JDatabaseQuery group( mixed $columns)

Add a grouping column to the GROUP clause of the query.

Usage: $query->group('id');

Parameters

mixed $columns A string or array of ordering columns.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery having( mixed $conditions, string $glue = 'AND')

A conditions to the HAVING clause of the query.

Usage: $query->group('id')->having('COUNT(id) > 5');

Parameters

mixed $conditions A string or array of columns.
string $glue The glue by which to join the conditions. Defaults to AND.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery innerJoin( string $condition)

Add an INNER JOIN clause to the query.

Usage: $query->innerJoin('b ON b.id = a.id')->innerJoin('c ON c.id = b.id');

Parameters

string $condition The join condition.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery insert( mixed $table, boolean $incrementField = false)

Add a table name to the INSERT clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query.

Usage: $query->insert('#a')->set('id = 1'); $query->insert('#a')->columns('id, title')->values('1,2')->values('3,4'); $query->insert('#__a')->columns('id, title')->values(array('1,2', '3,4'));

Parameters

mixed $table The name of the table to insert data into.
boolean $incrementField The name of the field to auto increment.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery join( string $type, string $conditions)

Add a JOIN clause to the query.

Usage: $query->join('INNER', 'b ON b.id = a.id);

Parameters

string $type The type of join. This string is prepended to the JOIN keyword.
string $conditions A string or array of conditions.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery leftJoin( string $condition)

Add a LEFT JOIN clause to the query.

Usage: $query->leftJoin('b ON b.id = a.id')->leftJoin('c ON c.id = b.id');

Parameters

string $condition The join condition.

Return Value

JDatabaseQuery Returns this object to allow chaining.

int length( string $value)

Get the length of a string in bytes.

Note, use 'charLength' to find the number of characters in a string.

Usage: query->where($query->length('a').' > 3');

Parameters

string $value The string to measure.

Return Value

int

string nullDate( boolean $quoted = true)

Get the null or zero representation of a timestamp for the database driver.

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the nullDate method directly.

Usage: $query->where('modified_date <> '.$query->nullDate());

Parameters

boolean $quoted Optionally wraps the null date in database quotes (true by default).

Return Value

string Null or zero representation of a timestamp.

JDatabaseQuery order( mixed $columns)

Add an ordering column to the ORDER clause of the query.

Usage: $query->order('foo')->order('bar'); $query->order(array('foo','bar'));

Parameters

mixed $columns A string or array of ordering columns.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery outerJoin( string $condition)

Add an OUTER JOIN clause to the query.

Usage: $query->outerJoin('b ON b.id = a.id')->outerJoin('c ON c.id = b.id');

Parameters

string $condition The join condition.

Return Value

JDatabaseQuery Returns this object to allow chaining.

string quote( mixed $text, boolean $escape = true)

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

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the quote method directly.

Note that 'q' is an alias for this method as it is in JDatabaseDriver.

Usage: $query->quote('fulltext'); $query->q('fulltext'); $query->q(array('option', 'fulltext'));

Parameters

mixed $text A string or an array of strings to quote.
boolean $escape True to escape the string, false to leave it unchanged.

Return Value

string The quoted input string.

Exceptions

RuntimeException if the internal db property is not a valid object.

mixed quoteName( mixed $name, mixed $as = null)

Wrap an SQL statement identifier name such as column, table or database names in quotes to prevent injection risks and reserved word conflicts.

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the quoteName method directly.

Note that 'qn' is an alias for this method as it is in JDatabaseDriver.

Usage: $query->quoteName('#a'); $query->qn('#a');

Parameters

mixed $name The identifier name to wrap in quotes, or an array of identifier names to wrap in quotes. Each type supports dot-notation name.
mixed $as The AS query part associated to $name. It can be string or array, in latter case it has to be same length of $name; if is null there will not be any AS part for string or array element.

Return Value

mixed The quote wrapped name, same type of $name.

Exceptions

RuntimeException if the internal db property is not a valid object.

JDatabaseQuery rightJoin( string $condition)

Add a RIGHT JOIN clause to the query.

Usage: $query->rightJoin('b ON b.id = a.id')->rightJoin('c ON c.id = b.id');

Parameters

string $condition The join condition.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery select( mixed $columns)

Add a single column, or array of columns to the SELECT clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query. The select method can, however, be called multiple times in the same query.

Usage: $query->select('a.')->select('b.id'); $query->select(array('a.', 'b.id'));

Parameters

mixed $columns A string or an array of field names.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery set( mixed $conditions, string $glue = ',')

Add a single condition string, or an array of strings to the SET clause of the query.

Usage: $query->set('a = 1')->set('b = 2'); $query->set(array('a = 1', 'b = 2');

Parameters

mixed $conditions A string or array of string conditions.
string $glue The glue by which to join the condition strings. Defaults to ,. Note that the glue is set on first use and cannot be changed.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery setQuery( mixed $sql)

Allows a direct query to be provided to the database driver's setQuery() method, but still allow queries to have bounded variables.

Usage: $query->setQuery('select * from #__users');

Parameters

mixed $sql An SQL Query

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery update( string $table)

Add a table name to the UPDATE clause of the query.

Note that you must not mix insert, update, delete and select method calls when building a query.

Usage: $query->update('#__foo')->set(...);

Parameters

string $table A table to update.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery values( string $values)

Adds a tuple, or array of tuples that would be used as values for an INSERT INTO statement.

Usage: $query->values('1,2,3')->values('4,5,6'); $query->values(array('1,2,3', '4,5,6'));

Parameters

string $values A single tuple, or array of tuples.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery where( mixed $conditions, string $glue = 'AND')

Add a single condition, or an array of conditions to the WHERE clause of the query.

Usage: $query->where('a = 1')->where('b = 2'); $query->where(array('a = 1', 'b = 2'));

Parameters

mixed $conditions A string or array of where conditions.
string $glue The glue by which to join the conditions. Defaults to AND. Note that the glue is set on first use and cannot be changed.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery extendWhere( string $outerGlue, mixed $conditions, string $innerGlue = 'AND')

Extend the WHERE clause with a single condition or an array of conditions, with a potentially different logical operator from the one in the current WHERE clause.

Usage: $query->where(array('a = 1', 'b = 2'))->extendWhere('XOR', array('c = 3', 'd = 4')); will produce: WHERE ((a = 1 AND b = 2) XOR (c = 3 AND d = 4)

Parameters

string $outerGlue The glue by which to join the conditions to the current WHERE conditions.
mixed $conditions A string or array of WHERE conditions.
string $innerGlue The glue by which to join the conditions. Defaults to AND.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery orWhere( mixed $conditions, string $glue = 'AND')

Extend the WHERE clause with an OR and a single condition or an array of conditions.

Usage: $query->where(array('a = 1', 'b = 2'))->orWhere(array('c = 3', 'd = 4')); will produce: WHERE ((a = 1 AND b = 2) OR (c = 3 AND d = 4)

Parameters

mixed $conditions A string or array of WHERE conditions.
string $glue The glue by which to join the conditions. Defaults to AND.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery andWhere( mixed $conditions, string $glue = 'OR')

Extend the WHERE clause with an AND and a single condition or an array of conditions.

Usage: $query->where(array('a = 1', 'b = 2'))->andWhere(array('c = 3', 'd = 4')); will produce: WHERE ((a = 1 AND b = 2) AND (c = 3 OR d = 4)

Parameters

mixed $conditions A string or array of WHERE conditions.
string $glue The glue by which to join the conditions. Defaults to OR.

Return Value

JDatabaseQuery Returns this object to allow chaining.

void __clone()

Method to provide deep copy support to nested objects and arrays when cloning.

Return Value

void

JDatabaseQuery union( mixed $query, boolean $distinct = false, string $glue = '')

Add a query to UNION with the current query.

Multiple unions each require separate statements and create an array of unions.

Usage (the $query base query MUST be a select query): $query->union('SELECT name FROM #foo') $query->union('SELECT name FROM #foo', true) $query->union($query2)->union($query3)

The $query attribute as an array is deprecated and will not be supported in 4.0.

$query->union(array('SELECT name FROM #foo','SELECT name FROM #bar')) $query->union(array($query2, $query3))

Parameters

mixed $query The JDatabaseQuery object or string to union.
boolean $distinct True to only return distinct rows from the union.
string $glue The glue by which to join the conditions.

Return Value

JDatabaseQuery Returns this object to allow chaining.

JDatabaseQuery unionDistinct( mixed $query, string $glue = '')

Add a query to UNION DISTINCT with the current query. Simply a proxy to union with the DISTINCT keyword.

Usage: $query->unionDistinct('SELECT name FROM #__foo')

Parameters

mixed $query The JDatabaseQuery object or string to union.
string $glue The glue by which to join the conditions.

Return Value

JDatabaseQuery Returns this object to allow chaining.

See also

union

string format( string $format)

Find and replace sprintf-like tokens in a format string.

Each token takes one of the following forms: %% - A literal percent character. %[t] - Where [t] is a type specifier. %[n]$[x] - Where [n] is an argument specifier and [t] is a type specifier.

Types: a - Numeric: Replacement text is coerced to a numeric type but not quoted or escaped. e - Escape: Replacement text is passed to $this->escape(). E - Escape (extra): Replacement text is passed to $this->escape() with true as the second argument. n - Name Quote: Replacement text is passed to $this->quoteName(). q - Quote: Replacement text is passed to $this->quote(). Q - Quote (no escape): Replacement text is passed to $this->quote() with false as the second argument. r - Raw: Replacement text is used as-is. (Be careful)

Date Types: - Replacement text automatically quoted (use uppercase for Name Quote). - Replacement text should be a string in date format or name of a date column. y/Y - Year m/M - Month d/D - Day h/H - Hour i/I - Minute s/S - Second

Invariable Types: - Takes no argument. - Argument index not incremented. t - Replacement text is the result of $this->currentTimestamp(). z - Replacement text is the result of $this->nullDate(false). Z - Replacement text is the result of $this->nullDate(true).

Usage: $query->format('SELECT %1$n FROM %2$n WHERE %3$n = %4$a', 'foo', '#__foo', 'bar', 1); Returns: SELECT foo FROM #__foo WHERE bar = 1

Notes: The argument specifier is optional but recommended for clarity. The argument index used for unspecified tokens is incremented only when used.

Parameters

string $format The formatting string.

Return Value

string Returns a string produced according to the formatting string.

string dateAdd( string $date, string $interval, string $datePart)

Add to the current date and time.

Usage: $query->select($query->dateAdd()); Prefixing the interval with a - (negative sign) will cause subtraction to be used. Note: Not all drivers support all units.

Parameters

string $date The db quoted string representation of the date to add to. May be date or datetime
string $interval The string representation of the appropriate number of units
string $datePart The part of the date to perform the addition on

Return Value

string The string with the appropriate sql for addition of dates

JDatabaseQuery unionAll( mixed $query, boolean $distinct = false, string $glue = '')

Add a query to UNION ALL with the current query.

Multiple unions each require separate statements and create an array of unions.

Usage: $query->union('SELECT name FROM #__foo')

The $query attribute as an array is deprecated and will not be supported in 4.0.

$query->union(array('SELECT name FROM #foo','SELECT name FROM #bar'))

Parameters

mixed $query The JDatabaseQuery object or string to union.
boolean $distinct Not used - ignored.
string $glue Not used - ignored.

Return Value

JDatabaseQuery Returns this object to allow chaining.

See also

union

JDatabaseQuery selectRowNumber( string $orderBy, string $orderColumnAlias)

Return the number of the current row.

Usage: $query->select('id'); $query->selectRowNumber('ordering,publishup DESC', 'newordering'); $query->from('#__content');

Parameters

string $orderBy An expression of ordering for window function.
string $orderColumnAlias An alias for new ordering column.

Return Value

JDatabaseQuery Returns this object to allow chaining.

Exceptions

RuntimeException

string q($text, $escape = true)

Alias for quote method

Parameters

$text
$escape

Return Value

string

string qn($name, $as = null)

Alias for quoteName method

Parameters

$name
$as

Return Value

string

string e($text, $extra = false)

Alias for escape method

Parameters

$text
$extra

Return Value

string

JDatabaseQuery bind( string|integer $key = null, mixed $value = null, integer $dataType = PDO::PARAM_STR, integer $length, array $driverOptions = array())

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.

Parameters

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 &$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.

Return Value

JDatabaseQuery

mixed getBounded( mixed $key = null)

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

Parameters

mixed $key The bounded variable key to retrieve.

Return Value

mixed

string processLimit( string $query, integer $limit, integer $offset)

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.

Parameters

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

Return Value

string

JDatabaseQuery setLimit( integer $limit, integer $offset)

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)

Parameters

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

Return Value

JDatabaseQuery Returns this object to allow chaining.