Fat-Free Framework: DB\Jig\Mapper Class Reference

Fat-Free-Framework

Fat-Free Framework  3.1.0 API Reference

Flat-file DB mapper. More...

Inheritance diagram for DB\Jig\Mapper:
DB\Cursor Magic DB\Jig\Session

Public Member Functions

 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 cast ($obj=NULL)
 
 token ($str)
 
 find ($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key)
 
 copyto ($key)
 
 __construct (\DB\Jig $db, $file)
 
- Public Member Functions inherited from DB\Cursor
 find ($filter=NULL, array $options=NULL)
 
 insert ()
 
 update ()
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL)
 
 load ($filter=NULL, array $options=NULL)
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 

Public Attributes

 $file
 Data file.
 
 $id
 Document identifier.
 
 $document =array()
 Document contents.
 
- Public Attributes inherited from DB\Cursor
 $ptr =0
 Current position.
 
const E_Field ='Undefined field %s'
 

Protected Member Functions

 factory ($id, $row)
 

Protected Attributes

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

Detailed Description

Flat-file DB mapper.

Constructor & Destructor Documentation

DB\Jig\Mapper::__construct ( \DB\Jig  $db,
  $file 
)

Instantiate class

Returns
void
Parameters
$dbobject
$filestring

Member Function Documentation

DB\Jig\Mapper::cast (   $obj = NULL)

Return fields of mapper object as an associative array

Returns
array
Parameters
$objobject
DB\Jig\Mapper::clear (   $key)

Delete field

Returns
NULL
Parameters
$keystring
DB\Jig\Mapper::copyfrom (   $key)

Hydrate mapper object using hive array variable

Returns
NULL
Parameters
$keystring
DB\Jig\Mapper::copyto (   $key)

Populate hive array variable with mapper fields

Returns
NULL
Parameters
$keystring
DB\Jig\Mapper::count (   $filter = NULL,
  $ttl = 0 
)

Count records that match criteria

Returns
int
Parameters
$filterarray
$ttlint
DB\Jig\Mapper::erase (   $filter = NULL)

Delete current record

Returns
bool
Parameters
$filterarray
DB\Jig\Mapper::exists (   $key)

Return TRUE if field is defined

Returns
bool
Parameters
$keystring
DB\Jig\Mapper::factory (   $id,
  $row 
)
protected

Convert array to mapper object

Returns
object
Parameters
$idstring
$rowarray
DB\Jig\Mapper::find (   $filter = NULL,
array  $options = NULL,
  $ttl = 0,
  $log = TRUE 
)

Return records that match criteria

Returns
array|FALSE
Parameters
$filterarray
$optionsarray
$ttlint
$logbool
DB\Jig\Mapper::get (   $key)

Retrieve value of field

Returns
scalar|FALSE
Parameters
$keystring
DB\Jig\Mapper::insert ( )

Insert new record

Returns
array
DB\Jig\Mapper::reset ( )

Reset cursor

Returns
NULL
DB\Jig\Mapper::set (   $key,
  $val 
)

Assign value to field

Returns
scalar|FALSE
Parameters
$keystring
$valscalar
DB\Jig\Mapper::skip (   $ofs = 1)

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

Returns
array
Parameters
$ofsint
DB\Jig\Mapper::token (   $str)

Convert tokens in string expression to variable names

Returns
string
Parameters
$strstring
DB\Jig\Mapper::update ( )

Update current record

Returns
array

The documentation for this class was generated from the following file:
  • db/jig/mapper.php
Generated on Mon Aug 19 2013 21:28:02 for Fat-Free Framework by   doxygen 1.8.4