Class FOFDatabaseQuerySqlite

SQLite Query Building Class.

FOFDatabaseQuery

Extended by

FOFDatabaseQueryPdo

Extended by

FOFDatabaseQuerySqlite implements FOFDatabaseQueryPreparable, FOFDatabaseQueryLimitable

Package: FrameworkOnFramework\database
Copyright: Copyright (C) 2010-2016 Nicholas K. Dionysopoulos / Akeeba Ltd. All rights reserved.
License: General Public License version 2 or later; see LICENSE.txt This file is adapted from the Joomla! Platform. It is used to iterate a database cursor returning FOFTable objects instead of plain stdClass objects
Since: 12.1
Located at fof/database/query/sqlite.php

Methods summary

`public FOFDatabaseQuerySqlite`	# `bind( string\|integer $key = null, mixed & $value = null, integer $dataType = PDO::PARAM_STR, integer $length = 0, 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. 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 `$key` `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. `$value` `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. `$dataType` `integer` - $dataType Constant corresponding to a SQL datatype. `$length` `integer` - $length The length of the variable. Usually required for OUTPUT parameters. `$driverOptions` `array` - $driverOptions Optional driver options to be used. Returns `FOFDatabaseQuerySqlite` Since 12.1
`public 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. 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 `$key` `mixed` - $key The bounded variable key to retrieve. Returns `mixed` Since 12.1
`public string`	# `charLength( string $field, string $operator = null, string $condition = null )` Gets the number of characters in a string. 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 `$field` `string` - $field A value. `$operator` `string` - $operator Comparison operator between charLength integer value and $condition `$condition` `string` - $condition Integer value to compare charLength with. Returns `string` - The required char length call. Since 13.1 Overrides `FOFDatabaseQuery::charLength`
`public FOFDatabaseQuerySqlite`	# `clear( string $clause = null )` Clear data from the query or a specific clause of the query. Clear data from the query or a specific clause of the query. Parameters `$clause` `string` - $clause Optionally, the name of the clause to clear, or nothing to clear the whole query. Returns `FOFDatabaseQuerySqlite` - Returns this object to allow chaining. Since 12.1 Overrides `FOFDatabaseQuery::clear`
`public string`	# `concatenate( array $values, string $separator = null )` Concatenates an array of column names or values. Concatenates an array of column names or values. Usage: $query->select($query->concatenate(array('a', 'b'))); Parameters `$values` `array` - $values An array of values to concatenate. `$separator` `string` - $separator As separator to place between each value. Returns `string` - The concatenated values. Since 11.1 Overrides `FOFDatabaseQuery::concatenate`
`public string`	# `processLimit( string $query, integer $limit, integer $offset = 0 )` 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 FOFDatabaseQueryLimitable interface. 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 FOFDatabaseQueryLimitable interface. Parameters `$query` `string` - $query The query in string format `$limit` `integer` - $limit The limit for the result set `$offset` `integer` - $offset The offset for the result set Returns `string` Since 12.1
`public FOFDatabaseQuerySqlite`	# `setLimit( integer $limit = 0, integer $offset = 0 )` Sets the offset and limit for the result set, if the database driver supports it. 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 `$limit` `integer` - $limit The limit for the result set `$offset` `integer` - $offset The offset for the result set Returns `FOFDatabaseQuerySqlite` - Returns this object to allow chaining. Since 12.1
`public string`	# `dateAdd( datetime $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. 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. Parameters `$date` `datetime` - $date The date or datetime to add to `$interval` `string` - $interval The string representation of the appropriate number of units `$datePart` `string` - $datePart The part of the date to perform the addition on Returns `string` - The string with the appropriate sql for addition of dates Since 13.1 Link http://www.sqlite.org/lang_datefunc.html Overrides `FOFDatabaseQuery::dateAdd`
`public string`	# `currentTimestamp( )` Gets the current date and time. Gets the current date and time. Usage: $query->where('published_up < '.$query->currentTimestamp()); Returns `string` Since 3.4 Overrides `FOFDatabaseQuery::currentTimestamp`

Methods inherited from FOFDatabaseQuery

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

Magic methods summary

Magic methods inherited from FOFDatabaseQuery

e(), q(), qn()

Properties summary

`protected integer`	`$offset`	# The offset for the result set. The offset for the result set. Since 12.1
`protected integer`	`$limit`	# The limit for the result set. The limit for the result set. Since 12.1
`protected array`	`$bounded`	# Bounded object array Bounded object array Since 12.1

Properties inherited from FOFDatabaseQuery

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

Magic properties inherited from FOFDatabaseQuery

$group, $having, $select, $type