\RedBeanPHPCursor

Database Cursor Interface.

A cursor is used by Query Writers to fetch Query Result rows one row at a time. This is useful if you expect the result set to be quite large. This interface dscribes the API of a database cursor. There can be multiple implementations of the Cursor, by default RedBeanPHP offers the PDOCursor for drivers shipping with RedBeanPHP and the NULLCursor.

Summary

Methods
Constants
getNextItem()
reset()
close()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

getNextItem()

getNextItem() : array

Should retrieve the next row of the result set.

This method is used to iterate over the result set.

Returns

array

reset()

reset() : void

Resets the cursor by closing it and re-executing the statement.

This reloads fresh data from the database for the whole collection.

close()

close() : void

Closes the database cursor.

Some databases require a cursor to be closed before executing another statement/opening a new cursor.