interface JDatabaseQueryLimitable

Joomla Database Query Limitable Interface.

Adds bind/unbind methods as well as a getBounded() method to retrieve the stored bounded variables on demand prior to query execution.

Methods

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.

setLimit( integer $limit, integer $offset)

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

Details

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.