Docs For Class GALRowSet

GALRowSet __construct(
GALDesc
$source, [
$rows = array()])

Initializes this object and optionally adds rows.

This constructor initializes the $source property and optionally adds an array of GALRow objects.

Parameters:

GALDesc	$source	You can only add rows where the getParent() method returns the same as $source->getParent()
	$rows

[ Top ]

void add(
object
$container)

Adds rows to this list.

This method accepts rows as arguments and adds them to this list. The top level parent of $source and the top level parent of all rows that are to be added need to be the same, this is a reference to the same instance.

Tags:

throws:

GAL_EDatabase If a row hasn't got the same parent as $source.

Parameters:

object

$container

An instance of GALRow or an instance of GALResultIterator.

[ Top ]

bool contains(
GALRow
$row)

Checks if the specified row is in this list.

Tags:

return:

TRUE if the specified list is in this list, FALSE otherwise.

Parameters:

GALRow

$row

[ Top ]

int count(
)

Returns the number of rows in this GALRowSet.

Tags:

see:

GALResultIterator::count()

Implementation of:

GALResultIterator::count(): Returns the number of rows in this list or set.

[ Top ]

int countFields(
)

Returns the number of fields contained in $source.

Tags:

return:

$source->countFields()

Implementation of:

GALDesc::countFields(): Returns the number of fields contained in a result.

[ Top ]

void data_seek(
int
$index)

Sets the internal pointer to the specified row.

This method sets the internal row pointer $index so that the next row returned by fetch() is the one on position $index in the result (starting from zero).

Tags:

throws:	GAL_EDatabase If the index is out of range.
see:	GALResultIterator::data_seek()

Implementation of:

GALResultIterator::data_seek(): Moves the internal pointer to the row with the given position inside the list.

Parameters:

int

$index

[ Top ]

GALDesc fetch(
)

Fetches the current row from $rows.

This function returns $rows[$index] and increases $index. The class of the returned row is a subclass of GALRow.

Tags:

return:	The row that has been fetched, or FALSE if this iterator has reached the end.
see:	GALResultIterator::fetch()

Implementation of:

GALResultIterator::fetch(): Fetches the row the internal pointer points to and sets the internal pointer to the next row.

[ Top ]

GALRowSet filter(
string
$callback)

Filters $rows with a callback function.

Tags:

return:	All rows where the callback function returned TRUE.
see:	GALResultIterator::filter()

Implementation of:

GALResultIterator::filter(): Filters the rows of this iterator with a callback function.

Parameters:

string

$callback

The name of a callback function.

[ Top ]

array getFields(
)

Returns all fields contained in $source.

Tags:

return:	$source->GALResultIterator::getFields()
throws:	GAL_EDatabase

Implementation of:

GALDesc::getFields(): Returns all fields contained in a result.

[ Top ]

string getFlags(
string
$field)

Gets the flags of the given field.

This returns $source->GALResultIterator::getFlags()

Tags:

return:	$source->GALResultIterator::getFlags()
throws:	GAL_EDatabase

Implementation of:

GALDesc::getFlags(): Gets the flags of the given field.

Parameters:

string

$field

A field name.

[ Top ]

int getLength(
string
$field)

Gets the length of the given field.

This returns $source->GALResultIterator::getLength()

Tags:

return:	$source->GALResultIterator::getLength()
throws:	GAL_EDatabase

Implementation of:

GALDesc::getLength(): Gets the length of the given field.

Parameters:

string

$field

A field name.

[ Top ]

GALResultIterator getParent(
)

Returns the top level parent of $source.

Tags:

return:

$source->GALResultIterator::getParent()

Implementation of:

GALDesc::getParent(): Return the top level parent of an entity.

[ Top ]

array getRows(
)

Returns an array with all rows in this list.

Tags:

return:

$rows, an array of GALRow objects.

[ Top ]

string getTable(
string
$field)

Gets the name of the table the given field is contained in.

This returns $source->GALResultIterator::getTable()

Tags:

return:	$source->GALResultIterator::getTable()
throws:	GAL_EDatabase

Implementation of:

GALDesc::getTable(): Gets the name of the table the given field is contained in.

Parameters:

string

$field

A field name.

[ Top ]

string getType(
string
$field)

Gets the type of the given field.

This returns $source->GALResultIterator::getType()

Tags:

return:	$source->GALResultIterator::getType()
throws:	GAL_EDatabase

Implementation of:

GALDesc::getType(): Gets the type of the given field.

Parameters:

string

$field

A field name.

[ Top ]

bool isField(
string
$field)

Checks if the given field is contained in $source.

Tags:

return:

$source->GALResultIterator::isField()

Implementation of:

GALDesc::isField(): Checks if the given field is contained in a result.

Parameters:

string

$field

The name of a field.

[ Top ]

GALIteratorIterator iterator(
)

Creates a new iterator on the data of this iterator.

Tags:

see:

GALResultIterator::iterator()

Implementation of:

GALResultIterator::iterator(): Returns a new ResultIterator on the data of this iterator.

[ Top ]

int position(
)

Returns the index of the current row.

This method returns the index of the row that will be returned by the next call of fetch() (starting from zero)

Tags:

return:	$index
see:	GALResultIterator::position()

Implementation of:

GALResultIterator::position(): Gets the index of the row the internal pointer points top.

[ Top ]

void remove(
GALRow
$row)

Removes the specified row form this list.

If the row isn't in this list, nothing happens.

Parameters:

GALRow

$row

The row to remove.

[ Top ]

bool rewind(
)

Sets the internal pointer to zero.

This method changes the internal pointer so that it points to the first row, i.e. row 0.

Tags:

return:	FALSE if there are no rows in the result, TRUE otherwise.
see:	GALResultIterator::rewind()

Implementation of:

GALResultIterator::rewind(): Moves the internal pointer to position 0.

[ Top ]

void row(
mixed
$index)

Fetches the row with the specified index (starting from 0).

This method fetches the row that has the specified index without changing the internal pointer. It returns the same as

$this->data_seek($index);
$this->fetch();

, but the internal pointer keeps unchanged.

Tags:

throws:	GAL_EDatabase If the row index is out of range.
see:	GALResultIterator::row()

Implementation of:

GALResultIterator::row(): Fetches the row with the given index.

[ Top ]

array verticalFetch(
string
$field)

Returns the value of the specified field in all rows of this iterator.

Tags:

return:	An array with all values of the specified field.
throws:	GAL_EDatabase If the specified field doesn't exist.
see:	GALResultIterator::verticalFetch()
see:	GALResult::verticalFetch()

Implementation of:

GALResultIterator::verticalFetch(): Returns the value of a field in all rows of this iterator.

Parameters:

string

$field

The name of a field.

[ Top ]

Class: GALRowSet

Class Overview

Variables

Methods

Class Details

Class Variables

$index = 0

Tags:

$num_rows =

Tags:

$rows = array()

Tags:

$source =

Tags:

Class Methods

constructor __construct [line 1115]

Parameters:

method add [line 1347]

Tags:

Parameters:

method contains [line 1402]

Tags:

Parameters:

method count [line 1214]

Tags:

method countFields [line 1317]

Tags:

method data_seek [line 1136]

Tags:

Parameters:

method fetch [line 1164]

Tags:

method filter [line 1224]

Tags:

Parameters:

method getFields [line 1309]

Tags:

method getFlags [line 1267]

Tags:

Parameters:

method getLength [line 1289]

Tags:

Parameters:

method getParent [line 1334]

Tags:

method getRows [line 1393]

Tags:

method getTable [line 1300]

Tags:

Parameters:

method getType [line 1278]

Tags:

Parameters:

method isField [line 1326]

Tags:

Parameters:

method iterator [line 1256]

Tags:

method position [line 1152]

Tags:

method remove [line 1384]

Parameters:

method rewind [line 1182]

Tags:

method row [line 1204]

Tags:

method verticalFetch [line 1237]

Tags:

Parameters: