Docs For Class GALTableIterator

constructor __construct [line 467]

GALTableIterator __construct(
GALTable
$table, resource
$handle, [
$rowFactory = false])

Initializes this object.

This constructor is not intended to be called by a library user; it is called in GALTable::rawLoad().

Overridden in child classes as:

GALUserIterator::__construct()

GALNodeIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALFilmIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALHelpIterator::__construct()

GALCommentIterator::__construct()

GALImageIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALSeriesIterator::__construct()

GALGroupIterator::__construct(): Initializes the $glb variable, then calls the parent constructor.

GALInstanceIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALLoginIterator::__construct()

GALJobIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALCategoryIterator::__construct(): Initialize the $glb variable, then call parent constructor.

GALTokenIterator::__construct()

Overrides GALResult::__construct() (Initializes a GALResult.)

Parameters:

GALTable	$table	Used to initialize $table.
resource	$handle	The MySQL result resource of the query in GALTable::rawLoad().
	$rowFactory

[ Top ]

destructor __destruct [line 488]

void __destruct(
)

Overwrite inherited destructor.

The inherited destructor must be overwritten, because the $handle is already destroyed.

Overrides GALResult::__destruct() (Free memory associated with this query result.)

[ Top ]

method buildRow [line 520]

void buildRow(
GALResult
$source, array
&$data)

Implements the GALRowFactory interface.

Overridden in child classes as:

GALUserIterator::buildRow()

GALNodeIterator::buildRow()

GALFilmIterator::buildRow()

GALHelpIterator::buildRow()

GALCommentIterator::buildRow(): Constructs the items of this iterator.

GALImageIterator::buildRow()

GALSeriesIterator::buildRow()

GALGroupIterator::buildRow(): Constructs the items of this iterator.

GALInstanceIterator::buildRow()

GALLoginIterator::buildRow()

GALJobIterator::buildRow()

GALCategoryIterator::buildRow(): Constructs the items of this iterator.

GALTokenIterator::buildRow()

Overrides GALResult::buildRow() (Implements the GALRowFactory interface.)

Parameters:

GALResult	$source
array	&$data	Reference to an array containing the row data

[ Top ]

method countFields [line 664]

int countFields(
)

Returns the number of fields contained in a result.

Wrapper for GALResult::countFields().

Tags:

return:	$table->countFields()
see:	GALDesc::countFields()

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

[ Top ]

method data_seek [line 546]

void data_seek(
int
$index)

Sets the internal pointer to the specified row.

This method sets the internal row pointer 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()

Overrides GALResult::data_seek() (Sets the internal pointer to the specified row.)

Parameters:

int

$index

[ Top ]

method fetch [line 504]

GALTableRow fetch(
)

Fetches the current row from the database.

In contrast to GALResult::fetch(), all rows are built inside the constructor and stored internally. fetch() just acesses those stored data, very similar to GALRowSet::fetch()

Tags:

return:

The fetched row or FALSE if the iterator has reached the end.

Overrides GALResult::fetch() (Fetches a row from the MySQL query result.)

[ Top ]

method getFields [line 654]

array getFields(
)

Returns all fields contained in this result.

Tags:

return:	$table->getFields()
throws:	GAL_EDatabase
see:	GALDesc::getFields()

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

[ Top ]

method getFlags [line 620]

string getFlags(
string
$field)

Gets the flags of the given field.

Wrapper for GALResult::getFlags().

Tags:

return:	$table->getFlags()
throws:	GAL_EDatabase
todo:	Make it possible to inherit documentation from interfaces (not only from classes).
see:	GALDesc::getFlags()

Overrides GALResult::getFlags() (Gets the flags of the given field.)

Parameters:

string

$field

A field name.

[ Top ]

method getLength [line 644]

int getLength(
string
$field)

Gets the length of the given field.

Wrapper for GALResult::getLength().

Tags:

return:	$table->getLength()
throws:	GAL_EDatabase
see:	GALDesc::getLength()

Overrides GALResult::getLength() (Gets the length of the given field.)

Parameters:

string

$field

A field name.

[ Top ]

method getParent [line 494]

GALDesc getParent(
)

Returns the parent of this result.

In most cases this is $table

Tags:

return:

$table->getParent()

Overrides GALResult::getParent() (Returns a reference to this object.)

[ Top ]

method getRowFactory [line 534]

GALRowFactory getRowFactory(
)

Returns the factory to construct rows.

Overrides GALResult::getRowFactory() (Returns the factory to construct rows.)

[ Top ]

method getTable [line 603]

string getTable(
string
$field)

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

Just returns the name of the table this iteraor is loaded from.

Tags:

throws:	GAL_EDatabase If the field name is invalid.
see:	GALDesc::getTable()

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

Parameters:

string

$field

The name of a field.

[ Top ]

method getType [line 632]

string getType(
string
$field)

Gets the type of the given field.

Wrapper for GALResult::getType().

Tags:

return:	$table->getType()
throws:	GAL_EDatabase
see:	GALDesc::getType()

Overrides GALResult::getType() (Gets the type of the given field.)

Parameters:

string

$field

The name of a field.

[ Top ]

method setRowFactory [line 527]

void setRowFactory(
GALRowFactory
$rowFactory)

Changing the row factory is not possible.

Please set the row factory via GALTableIterator::__construct()

Overrides GALResult::setRowFactory() (Sets the factory to construct rows.)

Parameters:

GALRowFactory

$rowFactory

[ Top ]

method verticalFetch [line 578]

array verticalFetch(
string
$field)

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

In the following example the table "users" contains these three rows:

name, id
'Kurt', 1
'Egon', 2
'Herbert', 3
1. $database = new GALDatabase($host, $user, $password, $database);
2. $result = $database->query("SELECT `name`, `id` FROM `users`");
3. $names = $result->verticalFetch('name');
4. print_r($names);
would print
```
 Array
 (
     [0] => Kurt
     [1] => Egon
     [2] => Herbert
 )
```

to stdout.

Tags:

return:	An array with all values of the specified field in this result.
throws:	GAL_EDatabase If the specified field doesn't exist.

Overrides GALResult::verticalFetch() (Returns the value of the specified field in all rows of this iterator.)

Parameters:

string

$field

The name of a field.

[ Top ]

Class: GALTableIterator

Class Overview

Variables

Methods

Child classes:

Inherited Variables

Class: GALResult

Inherited Methods

Class: GALResult

Class Details

Class Variables

$items = array()

Tags:

$table =

Tags:

Class Methods

constructor __construct [line 467]

Parameters:

destructor __destruct [line 488]

method buildRow [line 520]

Parameters:

method countFields [line 664]

Tags:

method data_seek [line 546]

Tags:

Parameters:

method fetch [line 504]

Tags:

method getFields [line 654]

Tags:

method getFlags [line 620]

Tags:

Parameters:

method getLength [line 644]

Tags:

Parameters:

method getParent [line 494]

Tags:

method getRowFactory [line 534]

method getTable [line 603]

Tags:

Parameters:

method getType [line 632]

Tags:

Parameters:

method setRowFactory [line 527]

Parameters:

method verticalFetch [line 578]

Tags:

Parameters: