\RedBeanPHP\CursorPDOCursor

PDO Database Cursor Implementation of PDO Database Cursor.

Used by the BeanCollection to fetch one bean at a time. The PDO Cursor is used by Query Writers to support retrieval of large bean collections. For instance, this class is used to implement the findCollection()/BeanCollection functionality.

Summary

Methods

Properties

Constants

__construct()
getNextItem()
reset()
close()

No public properties found

No constants found

No protected methods found

$res
$fetchStyle

N/A

No private methods found

No private properties found

N/A

File: Cursor/PDOCursor.php
Package: Default
Class hierarchy: \RedBeanPHP\Cursor\PDOCursor
Implements: \RedBeanPHP\Cursor

Properties

$res

$res : \PDOStatement

Type

\PDOStatement

$fetchStyle

$fetchStyle : string

Type

string

Methods

__construct()

__construct(\PDOStatement  $res, string  $fetchStyle) : void

Constructor, creates a new instance of a PDO Database Cursor.

Parameters

\PDOStatement	$res	the PDO statement
string	$fetchStyle	fetch style constant to use

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.

file	RedBeanPHP/Cursor/PDOCursor.php
author	Gabor de Mooij and the RedBeanPHP Community
license	BSD/GPLv2
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.