SourceForge.net LogoPHPGallue
[ class tree: libbase ] [ index: libbase ] [ all elements ]

Class: GALDesc

Source Location: /libbase/result.inc.php

Interface Overview


Information about a query result.


Methods


Child classes:

GALResultIterator
A set of GALRow objects.

Class Details

[line 32]
Information about a query result.

A class that implemets this interface is able to provide information about the structure of the result of a query, e.g. the fields that are contained in the result.




[ Top ]


Class Methods


method countFields [line 71]

int countFields( )

Returns the number of fields contained in a result.



[ Top ]

method getFields [line 66]

array getFields( )

Returns all fields contained in a result.



Tags:

return:  An array with all field names as strings.


[ Top ]

method getFlags [line 40]

string getFlags( string $field)

Gets the flags of the given field.

Wrapper for mysql_field_flags().




Parameters:

string   $field   The name of a field.

[ Top ]

method getLength [line 54]

int getLength( string $field)

Gets the length of the given field.

Wrapper for mysql_field_len().




Parameters:

string   $field   The name of a field.

[ Top ]

method getParent [line 93]

GALDesc getParent( )

Return the top level parent of an entity.

Example: A GALRow is fetched from a GALResult. Both implement the interface GALDesc that describes their structure. getParent() called for the GALResult object returns the object itself, it is (so to say) it's own parent, while getParent() called for the GALRow returns the GALResult it is fetched from. Note that getParent() should return the top level parent, so internally the getParent() method of a a subordinate object calls getParent() for it's parent!




[ Top ]

method getTable [line 61]

string getTable( string $field)

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

Wrapper for mysql_field_table().




Parameters:

string   $field   The name of a field.

[ Top ]

method getType [line 47]

string getType( string $field)

Gets the type of the given field.

Wrapper for mysql_field_type().




Parameters:

string   $field   The name of a field.

[ Top ]

method isField [line 77]

bool isField( string $field)

Checks if the given field is contained in a result.



Parameters:

string   $field   The name of a field.

[ Top ]


Documentation generated on Wed, 16 Aug 2006 15:36:25 +0200 by phpDocumentor 1.3.0RC6