DB\SQL\Mapper Class Reference

SQL data mapper. More...

Inheritance diagram for DB\SQL\Mapper:

Public Member Functions
	dbtype ()
	exists ($key)
	set ($key, $val)
&	get ($key)
	clear ($key)
	type ($pdo)
	cast ($obj=NULL)
	select ($fields, $filter=NULL, array $options=NULL, $ttl=0)
	find ($filter=NULL, array $options=NULL, $ttl=0)
	count ($filter=NULL, $ttl=0)
	skip ($ofs=1)
	insert ()
	update ()
	erase ($filter=NULL)
	reset ()
	copyfrom ($key, $func=NULL)
	copyto ($key)
	schema ()
	fields ($adhoc=TRUE)
	getiterator ()
	__construct (\DB\SQL $db, $table, $fields=NULL, $ttl=60)
Public Member Functions inherited from DB\Cursor
	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
	$engine
	Database engine.
	$source
	SQL table.
	$table
	SQL table (quoted)
	$_id
	Last insert ID.
	$fields
	Defined fields.
	$adhoc =array()
	Adhoc fields.
const	E_Adhoc ='Unable to process ad hoc field %s'
Public Attributes inherited from DB\Cursor
	$ptr =0
	Current position.
	$trigger =array()
	Event listeners.
const	E_Field ='Undefined field %s'

Protected Member Functions
	factory ($row)

Protected Attributes
	$db
	PDO wrapper.
Protected Attributes inherited from DB\Cursor
	$query =array()
	Query results.

Detailed Description

SQL data mapper.

Constructor & Destructor Documentation

DB\SQL\Mapper::__construct	(	\DB\SQL	$db,
			$table,
			$fields = NULL,
			$ttl = 60
	)

Instantiate class

Parameters

$db	object
$table	string
$fields	array|string
$ttl	int

Member Function Documentation

DB\SQL\Mapper::cast

(

$obj = NULL

)

Return fields of mapper object as an associative array

Returns

array

Parameters

$obj

object

DB\SQL\Mapper::clear

(

$key

)

Clear value of field

Returns

NULL

Parameters

$key

string

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

Hydrate mapper object using hive array variable

Returns

NULL

Parameters

$key	string
$func	callback

DB\SQL\Mapper::copyto

(

$key

)

Populate hive array variable with mapper fields

Returns

NULL

Parameters

$key

string

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

Count records that match criteria

Returns

int

Parameters

$filter	string|array
$ttl	int

DB\SQL\Mapper::dbtype

(

)

Return database type

Returns

string

DB\SQL\Mapper::erase

(

$filter = NULL

)

Delete current record

Returns

int

Parameters

$filter

string|array

DB\SQL\Mapper::exists

(

$key

)

Return TRUE if field is defined

Returns

bool

Parameters

$key

string

DB\SQL\Mapper::factory (   $row )

protected

Convert array to mapper object

Returns

object

Parameters

$row

array

DB\SQL\Mapper::fields

(

$adhoc = TRUE

)

Return field names

Returns

array

Parameters

$adhoc

bool

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

Return records that match criteria

Returns

array

Parameters

$filter	string|array
$options	array
$ttl	int

& DB\SQL\Mapper::get

(

$key

)

Retrieve value of field

Returns

scalar

Parameters

$key

string

DB\SQL\Mapper::getiterator

(

)

Retrieve external iterator for fields

Returns

object

DB\SQL\Mapper::insert

(

)

Insert new record

Returns

object

DB\SQL\Mapper::reset

(

)

Reset cursor

Returns

NULL

DB\SQL\Mapper::schema

(

)

Return schema

Returns

array

DB\SQL\Mapper::select	(		$fields,
			$filter = NULL,
		array	$options = NULL,
			$ttl = 0
	)

Build query string and execute

Returns

array

Parameters

$fields	string
$filter	string|array
$options	array
$ttl	int

DB\SQL\Mapper::set	(		$key,
			$val
	)

Assign value to field

Returns

scalar

Parameters

$key	string
$val	scalar

DB\SQL\Mapper::skip

(

$ofs = 1

)

Return record at specified offset using same criteria as previous load() call and make it active

Returns

array

Parameters

$ofs

int

DB\SQL\Mapper::type

(

$pdo

)

Get PHP type equivalent of PDO constant

Returns

string

Parameters

$pdo

string

DB\SQL\Mapper::update

(

)

Update current record

Returns

object

---

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

• db/sql/mapper.php