Packageindex Classtrees Modulegroups Elementlist Report XML Files

File: /home/mitarbeiter/sven/public_html/tmp/devcon_php_base/cursor/merged.class.php
dev/con php base - Cursor interfaces

cursor_merged

cursor
   |
  +-- cursor_merged

Cursor that makes an array of cursors behave like one.

 

public class cursor_merged extends cursor

Cursor that makes an array of cursors behave like one.
The last record/cursor that was get()'ed is referred to as the'current' cursor.

 

Methods inherited from cursor

cursor, query, ¤t, &get, &factory, __sleep

Public Method Summary

void

cursor_merged()

Construct cursor.

Private Method Summary

void

_query(array &$cursors)

Initialise with new set of cursors.
object cursor

&_pos()

Get reference to current cursor.
mixed

&_get()

Get record and use it with the other functions.
void

set(mixed $value)

Update a row's field.
void

create([ integer $pre ])

Create a record in the current cursor.
void

delete()

Delete the record the current cursor points to.
int

size()

Get the number of records in all cursors.Warning: documentation is missing.
void

_die( $func)

Print an error message for an unsupported function.
string

source()

Get the current cursor's source name.Warning: documentation is missing.
mixed

key()

Get the current cursor's source name.Warning: documentation is missing.
void

set_field(string $field)

Select a field in the current record.Warning: documentation is missing.
void

field()

Get the name of the currently selected field.Warning: documentation is missing.
void

type()

Get the type of the currently used cursor.Warning: documentation is missing.
string

id()

Get a unique ID string of the current record.Warning: documentation is missing.
void

&__sleep()

Serialize the cursor including the set.
void

set_source()

Warning: documentation is missing.
void

set_key( $key)

Warning: documentation is missing.

Fields inherited from cursor

$_source, $_key, $_field, $_type, $_lower, $_is_good, $_current, $_is_first, $_is_queried

Private Field Summary

unknown

$_cursors

unknown

$_index

unknown

$_size

Public Method Details

cursor_merged

public void cursor_merged( )

  Construct cursor.

Returns void


Private Method Details

_query

private void _query( array &$cursors )

  Initialise with new set of cursors.

Parameter
array &$cursors
Cursor set.
Returns void


&_pos

private object cursor &_pos( )

  Get reference to current cursor.

Returns object cursor

Reference to current cursor.


&_get

private mixed &_get( )

  Get record and use it with the other functions.

Returns mixed

Record .


set

private void set( mixed $value )

  Update a row's field.

Parameter
mixed $value
The new value of the selected field.
Returns void


create

private void create( [ integer $pre ] )

  Create a record in the current cursor.

Parameter
integer $pre = >>0<<
Preset values array keyed by field name.
Returns void


delete

private void delete( )

  Delete the record the current cursor points to.

Returns void


size

private int size( )

  Get the number of records in all cursors.

Warning: documentation is missing.

Returns int

Number of records.


_die

private void _die( $func )

  Print an error message for an unsupported function.

Parameter
$func
Warning: documentation is missing.
Returns void


source

private string source( )

  Get the current cursor's source name.

Warning: documentation is missing.

Returns string

Source name.


key

private mixed key( )

  Get the current cursor's source name.

Warning: documentation is missing.

Returns mixed

Key value of the last get()'ed record.


set_field

private void set_field( string $field )

  Select a field in the current record.

Warning: documentation is missing.

Parameter
string $field
The field's name.
Returns void


field

private void field( )

  Get the name of the currently selected field.

Warning: documentation is missing.

Returns void


type

private void type( )

  Get the type of the currently used cursor.

Warning: documentation is missing.

Returns void


id

private string id( )

  Get a unique ID string of the current record.

Warning: documentation is missing.

Returns string

The ID string.


&__sleep

private void &__sleep( )

  Serialize the cursor including the set.

Returns void


set_source

private void set_source( )

 

Warning: documentation is missing.

Returns void


set_key

private void set_key( $key )

 

Warning: documentation is missing.

Parameter
$key
Warning: documentation is missing.
Returns void


Private Field Details

$_cursors

private unknown $_cursors

>><<



$_index

private unknown $_index

>><<



$_size

private unknown $_size

>><<




Packageindex Classtrees Modulegroups Elementlist Report XML Files
PHPDoc 1.0beta