PHP Класс DB\Cursor

Наследование: extends Magic
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$ptr @}
$query @}
$trigger @}

Открытые методы

Метод Описание
aftererase ( $func ) : callback Define aftererase trigger
afterinsert ( $func ) : callback Define afterinsert trigger
aftersave ( $func ) : callback Define aftersave trigger
afterupdate ( $func ) : callback Define afterupdate trigger
beforeerase ( $func ) : callback Define beforeerase trigger
beforeinsert ( $func ) : callback Define beforeinsert trigger
beforesave ( $func ) : callback Define beforesave trigger
beforeupdate ( $func ) : callback Define beforeupdate trigger
cast ( $obj = NULL ) : array Return fields of mapper object as an associative array
copyfrom ( $var, $func = NULL ) : null Hydrate mapper object using hive array variable
copyto ( $key ) : null Populate hive array variable with mapper fields
count ( $filter = NULL, $ttl ) : integer Count records that match criteria
dbtype ( ) : string Return database type
dry ( ) : boolean Return TRUE if current cursor position is not mapped to any record
erase ( ) : integer | boolean Delete current record
fields ( ) : array Return field names
find ( $filter = NULL, array $options = NULL, $ttl ) : array Return records (array of mapper objects) that match criteria
findone ( $filter = NULL, array $options = NULL, $ttl ) : static | FALSE Return first record (mapper object) that matches criteria
first ( ) : mixed Map to first record in cursor
getiterator ( ) Get cursor's equivalent external iterator Causes a fatal error in PHP 5.3.5 if uncommented return ArrayIterator
insert ( ) : array Insert new record
last ( ) : mixed Map to last record in cursor
load ( $filter = NULL, array $options = NULL, $ttl ) : array | FALSE Map to first record that matches criteria
loaded ( ) : integer Return the count of records loaded
next ( ) : mixed Map next record
onerase ( $func ) : callback Define onerase trigger
oninsert ( $func ) : callback Define oninsert trigger
onload ( $func ) : callback Define onload trigger
onsave ( $func ) : callback Define onsave trigger
onupdate ( $func ) : callback Define onupdate trigger
paginate ( $pos, $size = 10, $filter = NULL, array $options = NULL, $ttl ) : array Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position
prev ( ) : mixed Map previous record
reset ( ) : null Reset cursor
save ( ) : mixed Save mapped record
skip ( $ofs = 1 ) : mixed Map to nth record relative to current cursor position
update ( ) : array Update current record
valid ( ) Return whether current iterator position is valid.

Описание методов

aftererase() публичный Метод

Define aftererase trigger
public aftererase ( $func ) : callback
$func callback
Результат callback

afterinsert() публичный Метод

Define afterinsert trigger
public afterinsert ( $func ) : callback
$func callback
Результат callback

aftersave() публичный Метод

Define aftersave trigger
public aftersave ( $func ) : callback
$func callback
Результат callback

afterupdate() публичный Метод

Define afterupdate trigger
public afterupdate ( $func ) : callback
$func callback
Результат callback

beforeerase() публичный Метод

Define beforeerase trigger
public beforeerase ( $func ) : callback
$func callback
Результат callback

beforeinsert() публичный Метод

Define beforeinsert trigger
public beforeinsert ( $func ) : callback
$func callback
Результат callback

beforesave() публичный Метод

Define beforesave trigger
public beforesave ( $func ) : callback
$func callback
Результат callback

beforeupdate() публичный Метод

Define beforeupdate trigger
public beforeupdate ( $func ) : callback
$func callback
Результат callback

cast() абстрактный публичный Метод

Return fields of mapper object as an associative array
abstract public cast ( $obj = NULL ) : array
$obj object
Результат array

copyfrom() абстрактный публичный Метод

Hydrate mapper object using hive array variable
abstract public copyfrom ( $var, $func = NULL ) : null
$var array|string
$func callback
Результат null

copyto() абстрактный публичный Метод

Populate hive array variable with mapper fields
abstract public copyto ( $key ) : null
$key string
Результат null

count() абстрактный публичный Метод

Count records that match criteria
abstract public count ( $filter = NULL, $ttl ) : integer
$filter array
$ttl int
Результат integer

dbtype() абстрактный публичный Метод

Return database type
abstract public dbtype ( ) : string
Результат string

dry() публичный Метод

Return TRUE if current cursor position is not mapped to any record
public dry ( ) : boolean
Результат boolean

erase() публичный Метод

Delete current record
public erase ( ) : integer | boolean
Результат integer | boolean

fields() абстрактный публичный Метод

Return field names
abstract public fields ( ) : array
Результат array

find() абстрактный публичный Метод

Return records (array of mapper objects) that match criteria
abstract public find ( $filter = NULL, array $options = NULL, $ttl ) : array
$filter string|array
$options array array
$ttl int
Результат array

findone() публичный Метод

Return first record (mapper object) that matches criteria
public findone ( $filter = NULL, array $options = NULL, $ttl ) : static | FALSE
$filter string|array
$options array array
$ttl int
Результат static | FALSE

first() публичный Метод

Map to first record in cursor
public first ( ) : mixed
Результат mixed

getiterator() абстрактный публичный Метод

Get cursor's equivalent external iterator Causes a fatal error in PHP 5.3.5 if uncommented return ArrayIterator
abstract public getiterator ( )

insert() абстрактный публичный Метод

Insert new record
abstract public insert ( ) : array
Результат array

last() публичный Метод

Map to last record in cursor
public last ( ) : mixed
Результат mixed

load() публичный Метод

Map to first record that matches criteria
public load ( $filter = NULL, array $options = NULL, $ttl ) : array | FALSE
$filter string|array
$options array array
$ttl int
Результат array | FALSE

loaded() публичный Метод

Return the count of records loaded
public loaded ( ) : integer
Результат integer

next() публичный Метод

Map next record
public next ( ) : mixed
Результат mixed

onerase() публичный Метод

Define onerase trigger
public onerase ( $func ) : callback
$func callback
Результат callback

oninsert() публичный Метод

Define oninsert trigger
public oninsert ( $func ) : callback
$func callback
Результат callback

onload() публичный Метод

Define onload trigger
public onload ( $func ) : callback
$func callback
Результат callback

onsave() публичный Метод

Define onsave trigger
public onsave ( $func ) : callback
$func callback
Результат callback

onupdate() публичный Метод

Define onupdate trigger
public onupdate ( $func ) : callback
$func callback
Результат callback

paginate() публичный Метод

Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position
public paginate ( $pos, $size = 10, $filter = NULL, array $options = NULL, $ttl ) : array
$pos int
$size int
$filter string|array
$options array array
$ttl int
Результат array

prev() публичный Метод

Map previous record
public prev ( ) : mixed
Результат mixed

reset() публичный Метод

Reset cursor
public reset ( ) : null
Результат null

save() публичный Метод

Save mapped record
public save ( ) : mixed
Результат mixed

skip() публичный Метод

Map to nth record relative to current cursor position
public skip ( $ofs = 1 ) : mixed
$ofs int
Результат mixed

update() абстрактный публичный Метод

Update current record
abstract public update ( ) : array
Результат array

valid() публичный Метод

Return whether current iterator position is valid.
public valid ( )

Описание свойств

$ptr защищенное свойство

@}
protected $ptr

$query защищенное свойство

@}
protected $query

$trigger защищенное свойство

@}
protected $trigger