DB\Cursor Class Reference

Simple cursor implementation. More...

Inheritance diagram for DB\Cursor:

Public Member Functions
	dbtype ()
	fields ()
	cast ($obj=NULL)
	find ($filter=NULL, array $options=NULL, $ttl=0)
	count ($filter=NULL, $ttl=0)
	insert ()
	update ()
	copyfrom ($key, $func=NULL)
	copyto ($key)
	dry ()
	findone ($filter=NULL, array $options=NULL, $ttl=0)
	paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
	load ($filter=NULL, array $options=NULL, $ttl=0)
	loaded ()
	first ()
	last ()
	skip ($ofs=1)
	next ()
	prev ()
	valid ()
	save ()
	erase ()
	onload ($func)
	beforeinsert ($func)
	afterinsert ($func)
	oninsert ($func)
	beforeupdate ($func)
	afterupdate ($func)
	onupdate ($func)
	beforesave ($func)
	aftersave ($func)
	onsave ($func)
	beforeerase ($func)
	aftererase ($func)
	onerase ($func)
	reset ()
Public Member Functions inherited from Magic
	exists ($key)
	set ($key, $val)
&	get ($key)
	clear ($key)
	offsetexists ($key)
	offsetset ($key, $val)
&	offsetget ($key)
	offsetunset ($key)
	__isset ($key)
	__set ($key, $val)
&	__get ($key)
	__unset ($key)

Public Attributes
	$ptr =0
	Current position.
	$trigger =array()
	Event listeners.
const	E_Field ='Undefined field %s'

Protected Attributes
	$query =array()
	Query results.

Detailed Description

Simple cursor implementation.

Member Function Documentation

DB\Cursor::aftererase

(

$func

)

Define aftererase trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::afterinsert

(

$func

)

Define afterinsert trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::aftersave

(

$func

)

Define aftersave trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::afterupdate

(

$func

)

Define afterupdate trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::beforeerase

(

$func

)

Define beforeerase trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::beforeinsert

(

$func

)

Define beforeinsert trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::beforesave

(

$func

)

Define beforesave trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::beforeupdate

(

$func

)

Define beforeupdate trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::cast (   $obj = NULL )

abstract

Return fields of mapper object as an associative array

Returns

array

Parameters

$obj

object

DB\Cursor::copyfrom (   $key,   $func = NULL  )

abstract

Hydrate mapper object using hive array variable

Returns

NULL

Parameters

$key	string
$func	callback

DB\Cursor::copyto (   $key )

abstract

Populate hive array variable with mapper fields

Returns

NULL

Parameters

$key

string

DB\Cursor::count (   $filter = NULL,   $ttl = 0  )

abstract

Count records that match criteria

Returns

int

Parameters

$filter	array
$ttl	int

DB\Cursor::dbtype ( )

abstract

Return database type

Returns

string

DB\Cursor::dry

(

)

Get cursor's equivalent external iterator Causes a fatal error in PHP 5.3.5if uncommented return ArrayIterator Return TRUE if current cursor position is not mapped to any record

Returns

bool

DB\Cursor::erase

(

)

Delete current record

Returns

int|bool

DB\Cursor::fields ( )

abstract

Return field names

Returns

array

DB\Cursor::find (   $filter = NULL, array  $options = NULL,   $ttl = 0  )

abstract

Return records (array of mapper objects) that match criteria

Returns

array

Parameters

$filter	string|array
$options	array
$ttl	int

DB\Cursor::findone	(		$filter = NULL,
		array	$options = NULL,
			$ttl = 0
	)

Return first record (mapper object) that matches criteria

Returns

object|FALSE

Parameters

$filter	string|array
$options	array
$ttl	int

DB\Cursor::first

(

)

Map to first record in cursor

Returns

mixed

DB\Cursor::insert ( )

abstract

Insert new record

Returns

array

DB\Cursor::last

(

)

Map to last record in cursor

Returns

mixed

DB\Cursor::load	(		$filter = NULL,
		array	$options = NULL,
			$ttl = 0
	)

Map to first record that matches criteria

Returns

array|FALSE

Parameters

$filter	string|array
$options	array
$ttl	int

DB\Cursor::loaded

(

)

Return the count of records loaded

Returns

int

DB\Cursor::next

(

)

Map next record

Returns

mixed

DB\Cursor::onerase

(

$func

)

Define onerase trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::oninsert

(

$func

)

Define oninsert trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::onload

(

$func

)

Define onload trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::onsave

(

$func

)

Define onsave trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::onupdate

(

$func

)

Define onupdate trigger

Returns

callback

Parameters

$func

callback

DB\Cursor::paginate	(		$pos = 0,
			$size = 10,
			$filter = NULL,
		array	$options = NULL,
			$ttl = 0
	)

Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position

Returns

array

Parameters

$pos	int
$size	int
$filter	string|array
$options	array
$ttl	int

DB\Cursor::prev

(

)

Map previous record

Returns

mixed

DB\Cursor::reset

(

)

Reset cursor

Returns

NULL

DB\Cursor::save

(

)

Save mapped record

Returns

mixed

DB\Cursor::skip

(

$ofs = 1

)

Map to nth record relative to current cursor position

Returns

mixed

Parameters

$ofs

int

DB\Cursor::update ( )

abstract

Update current record

Returns

array

DB\Cursor::valid

(

)

Return whether current iterator position is valid.

---

The documentation for this class was generated from the following file:

• db/cursor.php