Class FOFDatabaseQuerySqlsrv

Query Building Class.

FOFDatabaseQuery

Extended by

FOFDatabaseQuerySqlsrv implements FOFDatabaseQueryLimitable

Direct known subclasses

FOFDatabaseQuerySqlazure

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: 11.1
Located at fof/database/query/sqlsrv.php

Methods summary

`public string`	# `__toString( )` Magic function to convert the query to a string. Magic function to convert the query to a string. Returns `string` - The completed query. Since 11.1 Overrides `FOFDatabaseQuery::__toString`
`public string`	# `castAsChar( string $value )` Casts a value to a char. Casts a value to a char. Ensure that the value is properly quoted before passing to the method. Parameters `$value` `string` - $value The value to cast as a char. Returns `string` - Returns the cast value. Since 11.1 Overrides `FOFDatabaseQuery::castAsChar`
`public string`	# `charLength( string $field, string $operator = null, string $condition = null )` Gets the function to determine the length of a character string. Gets the function to determine the length of a character string. 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 11.1 Overrides `FOFDatabaseQuery::charLength`
`public string`	# `concatenate( array $values, string $separator = null )` Concatenates an array of column names or values. Concatenates an array of column names or values. 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`	# `currentTimestamp( )` Gets the current date and time. Gets the current date and time. Returns `string` Since 11.1 Overrides `FOFDatabaseQuery::currentTimestamp`
`public integer`	# `length( string $value )` Get the length of a string in bytes. Get the length of a string in bytes. Parameters `$value` `string` - $value The string to measure. Returns `integer` Since 11.1 Overrides `FOFDatabaseQuery::length`
`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 to add to; type may be time or datetime. `$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 for more information Note Not all drivers support all units. Overrides `FOFDatabaseQuery::dateAdd`
`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. 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. 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 FOFDatabaseQuery`	# `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 `FOFDatabaseQuery` - Returns this object to allow chaining. Since 12.1
`public string`	# `Rand( )` Return correct rand() function for MSSQL. Return correct rand() function for MSSQL. Ensure that the rand() function is MSSQL compatible. Usage: $query->Rand(); Returns `string` - The correct rand function. Since 3.5

Methods inherited from FOFDatabaseQuery

__call(), __clone(), __construct(), __get(), call(), clear(), columns(), dateFormat(), day(), delete(), dump(), escape(), exec(), format(), from(), group(), having(), hour(), innerJoin(), insert(), join(), leftJoin(), 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 string`	`$name_quotes`	# The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote. The character(s) used to quote SQL statement names such as table names or field names, etc. The child classes should define this as necessary. If a single character string the same character is used for both sides of the quoted name, else the first character will be used for the opening quote and the second for the closing quote. Since 11.1
`protected string`	`$null_date`	# The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine. The null or zero representation of a timestamp for the database driver. This should be defined in child classes to hold the appropriate value for the engine. Since 11.1
`protected integer`	`$limit`	# The affected row limit for the current SQL statement. The affected row limit for the current SQL statement. Since 3.2
`protected integer`	`$offset`	# The affected row offset to apply for the current SQL statement. The affected row offset to apply for the current SQL statement. Since 3.2

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