\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 describes 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

File: Cursor.php
Package: \Default

Tags

file	RedBeanPHP/Cursor.php
author	Gabor de Mooij and the RedBeanPHP Community
license	BSD/GPLv2
copyright	copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community This source file is subject to the BSD/GPLv2 License that is bundled with this source code in the file license.txt.

Methods

getNextItem()

getNextItem() : array|NULL

Should retrieve the next row of the result set.

This method is used to iterate over the result set.

Returns

array|NULL

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.