Abstract Class JDatabaseQuery

Description

Query Building Class.

  • method: string q(): q($text, $escape = true) Alias for quote method
  • method: string qn(): qn($name, $as = null) Alias for quoteName method
  • method: string e(): e($text, $extra = false) Alias for escape method
  • abstract:
  • since: 11.1

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


	
			
Direct descendents
Class Description
 class JDatabaseQueryMysqli Query Building Class.
 class JDatabaseQueryPdo PDO Query Building Class.
 class JDatabaseQueryPostgresql Query Building Class.
 class JDatabaseQuerySqlsrv Query Building Class.
Variable Summary
Method Summary
 JDatabaseQuery __construct ([JDatabaseDriver $db = null])
 JDatabaseQuery call (mixed $columns)
 string castAsChar (string $value)
 string charLength (string $field, [string $operator = null], [string $condition = null])
 JDatabaseQuery clear ([string $clause = null])
 JDatabaseQuery columns (mixed $columns)
 string concatenate (array $values, [string $separator = null])
 string currentTimestamp ()
 string dateAdd (datetime $date, string $interval, string $datePart)
 string dateFormat ()
 string day (string $date)
 JDatabaseQuery delete ([string $table = null])
 string dump ()
 string escape (string $text, [boolean $extra = false])
 JDatabaseQuery exec (mixed $columns)
 string format (string $format)
 JDatabaseQuery from (mixed $tables, [string $subQueryAlias = null])
 JDatabaseQuery group (mixed $columns)
 JDatabaseQuery having (mixed $conditions, [string $glue = 'AND'])
 string hour (string $date)
 JDatabaseQuery innerJoin (string $condition)
 JDatabaseQuery insert (mixed $table, [boolean $incrementField = false])
 JDatabaseQuery join (string $type, string $conditions)
 JDatabaseQuery leftJoin (string $condition)
 int length (string $value)
 string minute (string $date)
 string month (string $date)
 string nullDate ([boolean $quoted = true])
 JDatabaseQuery order (mixed $columns)
 JDatabaseQuery outerJoin (string $condition)
 string quote (mixed $text, [boolean $escape = true])
 mixed quoteName (mixed $name, [mixed $as = null])
 JDatabaseQuery rightJoin (string $condition)
 string second (string $date)
 JDatabaseQuery select (mixed $columns)
 JDatabaseQuery set (mixed $conditions, [string $glue = ','])
 JDatabaseQuery setQuery (mixed $sql)
 mixed union (mixed $query, [boolean $distinct = false], [string $glue = ''])
 mixed unionAll (mixed $query, [boolean $distinct = false], [string $glue = ''])
 mixed unionDistinct (mixed $query, [string $glue = ''])
 JDatabaseQuery update (string $table)
 JDatabaseQuery values (string $values)
 JDatabaseQuery where (mixed $conditions, [string $glue = 'AND'])
 string year (string $date)
 string __call (string $method, array $args)
 void __clone ()
 mixed __get (string $name)
 string __toString ()
Variables
object The $autoIncrementField = null (line 256)
  • var: auto increment insert field element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $call = null (line 262)
  • var: The call element.
  • since: 12.1
  • access: protected
JDatabaseQueryElement $columns = null (line 238)
  • var: The column list for an INSERT statement.
  • since: 11.1
  • access: protected
JDatabaseDriver $db = null (line 154)
  • var: The database driver.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $delete = null (line 184)
  • var: The delete element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $element = null (line 172)
  • var: The query element for a generic query (type = null).
  • since: 11.1
  • access: protected
JDatabaseQueryElement $exec = null (line 268)
  • var: The exec element.
  • since: 12.1
  • access: protected
JDatabaseQueryElement $from = null (line 202)
  • var: The from element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $group = null (line 226)
  • var: The group by element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $having = null (line 232)
  • var: The having element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $insert = null (line 196)
  • var: The insert element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $join = null (line 208)
  • var: The join element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $order = null (line 250)
  • var: The order element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $select = null (line 178)
  • var: The select element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $set = null (line 214)
  • var: The set element.
  • since: 11.1
  • access: protected
string $sql = null (line 160)
  • var: The SQL query (if a direct query string was provided).
  • since: 12.1
  • access: protected
string $type = '' (line 166)
  • var: The query type.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $union = null (line 274)
  • var: The union element.
  • since: 12.1
  • access: protected
JDatabaseQueryElement $unionAll = null (line 280)
  • var: The unionAll element.
  • since: 13.1
  • access: protected
JDatabaseQueryElement $update = null (line 190)
  • var: The update element.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $values = null (line 244)
  • var: The values list for an INSERT statement.
  • since: 11.1
  • access: protected
JDatabaseQueryElement $where = null (line 220)
  • var: The where element.
  • since: 11.1
  • access: protected
Methods
Constructor __construct (line 322)

Class constructor.

  • since: 11.1
  • access: public
JDatabaseQuery __construct ([JDatabaseDriver $db = null])
call (line 508)

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'));

  • return: Returns this object to allow chaining.
  • since: 12.1
  • access: public
JDatabaseQuery call (mixed $columns)
  • mixed $columns: A string or an array of field names.
castAsChar (line 538)

Casts a value to a char.

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

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

  • return: Returns the cast value.
  • since: 11.1
  • access: public
string castAsChar (string $value)
  • string $value: The value to cast as a char.

Redefined in descendants as:
charLength (line 559)

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'));

  • return: The required char length call.
  • since: 11.1
  • access: public
string charLength (string $field, [string $operator = null], [string $condition = null])
  • string $field: A value.
  • string $operator: Comparison operator between charLength integer value and $condition
  • string $condition: Integer value to compare charLength with.

Redefined in descendants as:
clear (line 573)

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery clear ([string $clause = null])
  • string $clause: Optionally, the name of the clause to clear, or nothing to clear the whole query.

Redefined in descendants as:
columns (line 696)

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery columns (mixed $columns)
  • mixed $columns: A column name, or array of column names.
concatenate (line 723)

Concatenates an array of column names or values.

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

  • return: The concatenated values.
  • since: 11.1
  • access: public
string concatenate (array $values, [string $separator = null])
  • array $values: An array of values to concatenate.
  • string $separator: As separator to place between each value.

Redefined in descendants as:
currentTimestamp (line 745)

Gets the current date and time.

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

  • since: 11.1
  • access: public
string currentTimestamp ()

Redefined in descendants as:
dateAdd (line 1800)

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.

  • return: The string with the appropriate sql for addition of dates
  • see: function_date-add
  • since: 13.1
  • access: public
string dateAdd (datetime $date, string $interval, string $datePart)
  • datetime $date: 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

Redefined in descendants as:
dateFormat (line 760)

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: The format string.
  • since: 11.1
  • access: public
string dateFormat ()
day (line 959)

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

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

  • return: Returns string to extract day from a date.
  • since: 12.1
  • access: public
string day (string $date)
  • string $date: Date column containing day to be extracted.

Redefined in descendants as:
delete (line 799)

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');

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery delete ([string $table = null])
  • string $table: The name of the table to delete from.
dump (line 780)

Creates a formatted dump of the query for debugging purposes.

Usage: echo $query->dump();

  • since: 11.3
  • access: public
string dump ()
escape (line 828)

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.

  • return: The escaped string.
  • since: 11.1
  • throws: RuntimeException if the internal db property is not a valid object.
  • access: public
string escape (string $text, [boolean $extra = false])
  • string $text: The string to be escaped.
  • boolean $extra: Optional parameter to provide extra escaping.
exec (line 854)

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'));

  • return: Returns this object to allow chaining.
  • since: 12.1
  • access: public
JDatabaseQuery exec (mixed $columns)
  • mixed $columns: A string or an array of field names.
format (line 1644)

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.

  • return: Returns a string produced according to the formatting string.
  • since: 12.3
  • access: public
string format (string $format)
  • string $format: The formatting string.
from (line 889)

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');

  • return: Returns this object to allow chaining.
  • throws: RuntimeException
  • since: 11.1
  • access: public
JDatabaseQuery from (mixed $tables, [string $subQueryAlias = null])
  • 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.
group (line 1027)

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

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery group (mixed $columns)
  • mixed $columns: A string or array of ordering columns.
having (line 1054)

A conditions to the HAVING clause of the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery having (mixed $conditions, [string $glue = 'AND'])
  • mixed $conditions: A string or array of columns.
  • string $glue: The glue by which to join the conditions. Defaults to AND.
hour (line 976)

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

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

  • return: Returns string to extract hour from a date.
  • since: 12.1
  • access: public
string hour (string $date)
  • string $date: Date column containing hour to be extracted.

Redefined in descendants as:
innerJoin (line 1081)

Add an INNER JOIN clause to the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery innerJoin (string $condition)
  • string $condition: The join condition.
insert (line 1105)

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'));

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery insert (mixed $table, [boolean $incrementField = false])
  • mixed $table: The name of the table to insert data into.
  • boolean $incrementField: The name of the field to auto increment.
join (line 1127)

Add a JOIN clause to the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery join (string $type, string $conditions)
  • string $type: The type of join. This string is prepended to the JOIN keyword.
  • string $conditions: A string or array of conditions.
leftJoin (line 1150)

Add a LEFT JOIN clause to the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery leftJoin (string $condition)
  • string $condition: The join condition.
length (line 1171)

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');

  • since: 11.1
  • access: public
int length (string $value)
  • string $value: The string to measure.

Redefined in descendants as:
minute (line 993)

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

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

  • return: Returns string to extract minute from a date.
  • since: 12.1
  • access: public
string minute (string $date)
  • string $date: Date column containing minute to be extracted.

Redefined in descendants as:
month (line 942)

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

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

  • return: Returns string to extract month from a date.
  • since: 12.1
  • access: public
string month (string $date)
  • string $date: Date column containing month to be extracted.

Redefined in descendants as:
nullDate (line 1191)

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());

  • return: Null or zero representation of a timestamp.
  • since: 11.1
  • access: public
string nullDate ([boolean $quoted = true])
  • boolean $quoted: Optionally wraps the null date in database quotes (true by default).
order (line 1221)

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

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery order (mixed $columns)
  • mixed $columns: A string or array of ordering columns.
outerJoin (line 1247)

Add an OUTER JOIN clause to the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery outerJoin (string $condition)
  • string $condition: The join condition.
quote (line 1275)

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'));

  • return: The quoted input string.
  • since: 11.1
  • throws: RuntimeException if the internal db property is not a valid object.
  • access: public
string quote (mixed $text, [boolean $escape = true])
  • mixed $text: A string or an array of strings to quote.
  • boolean $escape: True to escape the string, false to leave it unchanged.
quoteName (line 1308)

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');

  • return: The quote wrapped name, same type of $name.
  • since: 11.1
  • throws: RuntimeException if the internal db property is not a valid object.
  • access: public
mixed quoteName (mixed $name, [mixed $as = null])
  • 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.
rightJoin (line 1330)

Add a RIGHT JOIN clause to the query.

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

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery rightJoin (string $condition)
  • string $condition: The join condition.
second (line 1010)

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

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

  • return: Returns string to extract second from a date.
  • since: 12.1
  • access: public
string second (string $date)
  • string $date: Date column containing second to be extracted.

Redefined in descendants as:
select (line 1353)

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'));

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery select (mixed $columns)
  • mixed $columns: A string or an array of field names.
set (line 1384)

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');

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery set (mixed $conditions, [string $glue = ','])
  • 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.
setQuery (line 1413)

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');

  • return: Returns this object to allow chaining.
  • since: 12.1
  • access: public
JDatabaseQuery setQuery (mixed $sql)
  • mixed $sql: An SQL Query
union (line 1540)

Add a query to UNION with the current query.

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

Usage: $query->union('SELECT name FROM #__foo') $query->union('SELECT name FROM #__foo','distinct') $query->union(array('SELECT name FROM #__foo','SELECT name FROM #__bar'))

  • return: The JDatabaseQuery object on success or boolean false on failure.
  • since: 12.1
  • access: public
mixed union (mixed $query, [boolean $distinct = false], [string $glue = ''])
  • 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.
unionAll (line 1822)

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') $query->union('SELECT name FROM #__foo','distinct') $query->union(array('SELECT name FROM #__foo','SELECT name FROM #__bar'))

  • return: The JDatabaseQuery object on success or boolean false on failure.
  • since: 13.1
  • access: public
mixed unionAll (mixed $query, [boolean $distinct = false], [string $glue = ''])
  • 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.
unionDistinct (line 1589)

Add a query to UNION DISTINCT with the current query. Simply a proxy to Union with the Distinct clause.

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

  • return: The JDatabaseQuery object on success or boolean false on failure.
  • since: 12.1
  • access: public
mixed unionDistinct (mixed $query, [string $glue = ''])
  • mixed $query: The JDatabaseQuery object or string to union.
  • string $glue: The glue by which to join the conditions.
update (line 1434)

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(...);

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery update (string $table)
  • string $table: A table to update.
values (line 1455)

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'));

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery values (string $values)
  • string $values: A single tuple, or array of tuples.
where (line 1484)

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'));

  • return: Returns this object to allow chaining.
  • since: 11.1
  • access: public
JDatabaseQuery where (mixed $conditions, [string $glue = 'AND'])
  • 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.
year (line 925)

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

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

  • return: Returns string to extract year from a date.
  • since: 12.1
  • access: public
string year (string $date)
  • string $date: Date column containing year to be extracted.

Redefined in descendants as:
__call (line 292)

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

  • return: The aliased method's return value or null.
  • since: 11.1
  • access: public
string __call (string $method, array $args)
  • string $method: The called method.
  • array $args: The array of arguments passed to the method.
__clone (line 1507)

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

  • since: 11.3
  • access: public
void __clone ()
__get (line 487)

Magic function to get protected variable value

  • since: 11.1
  • access: public
mixed __get (string $name)
  • string $name: The name of the variable.
__toString (line 334)

Magic function to convert the query to a string.

  • return: The completed query.
  • since: 11.1
  • access: public
string __toString ()

Redefined in descendants as:

Documentation generated on Tue, 19 Nov 2013 15:11:32 +0100 by phpDocumentor 1.4.3