Class: ODBCResultSetCommon

Source Location: /creole/drivers/odbc/ODBCResultSetCommon.php

Class Overview

ResultSetCommon
   |
   --ODBCResultSetCommon

Base class for ODBC implementation of ResultSet.

Author(s):

Dave Lawson <dlawson@masterytech.com>

Version:

$Revision: 1.1 $

Child classes:

ODBCCachedResultSet: ODBC implementation of a cached ResultSet.

ODBCResultSet: ODBC implementation of ResultSet.

Inherited Variables

Class: ResultSetCommon

ResultSetCommon::$conn
ResultSetCommon::$cursorPos
ResultSetCommon::$fetchmode
ResultSetCommon::$fields
ResultSetCommon::$ignoreAssocCase
ResultSetCommon::$result

Inherited Methods

Class: ResultSetCommon

ResultSetCommon::__construct()
ResultSetCommon::absolute()
ResultSetCommon::afterLast()
ResultSetCommon::beforeFirst()
ResultSetCommon::first()
ResultSetCommon::get()
ResultSetCommon::getArray()
ResultSetCommon::getBlob()
ResultSetCommon::getBoolean()
ResultSetCommon::getClob()
ResultSetCommon::getCursorPos()
ResultSetCommon::getDate()
ResultSetCommon::getFetchmode()
ResultSetCommon::getFloat()
ResultSetCommon::getInt()
ResultSetCommon::getIterator()
ResultSetCommon::getResource()
ResultSetCommon::getRow()
ResultSetCommon::getString()
ResultSetCommon::getTime()
ResultSetCommon::getTimestamp()
ResultSetCommon::isAfterLast()
ResultSetCommon::isBeforeFirst()
ResultSetCommon::isIgnoreAssocCase()
ResultSetCommon::last()
ResultSetCommon::previous()
ResultSetCommon::relative()
ResultSetCommon::setFetchmode()
ResultSetCommon::__destruct(): Destructor

Class Details

[line 32]
Base class for ODBC implementation of ResultSet.

Tags:

abstract:
version:	$Revision: 1.1 $
author:	Dave Lawson <dlawson@masterytech.com>

[ Top ]

Class Variables

$limit = 0

[line 44]

Maximum rows to retrieve, or 0 if all (for emulated limit).

Tags:

access:

protected

Type:

int

[ Top ]

$offset = 0

[line 38]

Offset at which to start reading rows (for emulated offset).

Tags:

access:

protected

Type:

int

[ Top ]

Class Methods

constructor __construct [line 49]

ODBCResultSetCommon __construct(
Connection
$conn, mixed
$result, [mixed
$fetchmode = null])

Tags:

access:	public
see:	ResultSet::__construct()

Overridden in child classes as:

ODBCCachedResultSet::__construct()

ODBCResultSet::__construct()

Overrides ResultSetCommon::__construct() (parent method not documented)

[ Top ]

method close [line 57]

void close(
)

Tags:

access:	public
see:	ResultSet::close()

Overridden in child classes as:

ODBCCachedResultSet::close()

ODBCResultSet::close()

[ Top ]

method getFieldNum [line 101]

int getFieldNum(
mixed
$colname)

If fetchmode is FETCHMODE_ASSOC, returns the 1-based field index number for the specified column name. Otherwise returns 0 (false).

[ Top ]

method readLobData [line 128]

string readLobData(
int|string
$column, int
$binmode, [string
$curdata = null])

Reads in any unread LOB data. For long char fields, we may already have up to odbc_longreadlen() bytes in the buffer. These are passed in via the $curdata parm. For long binary fields, no data is read initially since odbc_binmode() is set to ODBC_BINMODE_PASSTHRU.

This method adjusts the binmode and longreadlen to finish reading these datatypes into the buffer. Returns a string with the complete contents.

Tags:

access:

protected

Parameters:

int\|string	$column	Column index or name to read data from.
int	$binmode	ODBC_BINMODE_RETURN for binary data, ODBC_BINMODE_CONVERT for char data.
string	$curdata	Existing LOB data already in buffer.

[ Top ]

method _setLimit [line 91]

void _setLimit(
int
$limit)

This function exists to set limit after ResultSet is instantiated.

This function should be "protected" in Java sense: only available to classes in package. THIS METHOD SHOULD NOT BE CALLED BY ANYTHING EXCEPTION DRIVER CLASSES.

Tags:

access:

public

Parameters:

int

$limit

New limit.

[ Top ]

method _setOffset [line 76]

void _setOffset(
int
$offset)

This function exists to set offset after ResultSet is instantiated.

This function should be "protected" in Java sense: only available to classes in package. THIS METHOD SHOULD NOT BE CALLED BY ANYTHING EXCEPTION DRIVER CLASSES.

Tags:

access:

public

Parameters:

int

$offset

New offset. If great than 0, then seek(0) will be called to move cursor.

[ Top ]

Documentation generated on Mon, 23 Aug 2004 21:52:26 -0400 by phpDocumentor 1.3.0RC3