Docs For Class JDatabaseQueryLimitable

Interface JDatabaseQueryLimitable

Description

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.

since: 12.1

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

Method Summary

string processLimit (string $query, integer $limit, [integer $offset = 0])

JDatabaseQuery setLimit ([integer $limit = 0], [integer $offset = 0])

Methods

processLimit (line 39)

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.

since: 12.1
access: public

string processLimit (string $query, integer $limit, [integer $offset = 0])

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

setLimit (line 55)

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)

return: Returns this object to allow chaining.
since: 12.1
access: public

JDatabaseQuery setLimit ([integer $limit = 0], [integer $offset = 0])

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

Documentation generated on Tue, 19 Nov 2013 15:07:05 +0100 by phpDocumentor 1.4.3