MDB2_BufferedResult_oci8 Class Reference

Inheritance diagram for MDB2_BufferedResult_oci8:

Collaboration diagram for MDB2_BufferedResult_oci8:

Public Member Functions
	_fillBuffer ($rownum=null)
	Fill the row buffer. More...
&	fetchRow ($fetchmode=MDB2_FETCHMODE_DEFAULT, $rownum=null)
	Fetch a row and insert the data into an existing array. More...
	seek ($rownum=0)
	Seek to a specific row in a result set. More...
	valid ()
	Check if the end of the result set has been reached. More...
	numRows ()
	Returns the number of rows in a result object. More...
	free ()
	Free the internal resources associated with $result. More...
Public Member Functions inherited from MDB2_Result_oci8
&	fetchRow ($fetchmode=MDB2_FETCHMODE_DEFAULT, $rownum=null)
	Fetch a row and insert the data into an existing array. More...
	_getColumnNames ()
	Retrieve the names of columns returned by the DBMS in a query result. More...
	numCols ()
	Count the number of columns returned by the DBMS in a query result. More...
	free ()
	Free the internal resources associated with $result. More...
Public Member Functions inherited from MDB2_Result_Common
	__construct (&$db, &$result, $limit=0, $offset=0)
	Constructor. More...
	MDB2_Result_Common (&$db, &$result, $limit=0, $offset=0)
	PHP 4 Constructor. More...
	setResultTypes ($types)
	Define the list of types to be associated with the columns of a given result set. More...
	seek ($rownum=0)
	Seek to a specific row in a result set. More...
&	fetchRow ($fetchmode=MDB2_FETCHMODE_DEFAULT, $rownum=null)
	Fetch and return a row of data. More...
	fetchOne ($colnum=0, $rownum=null)
	fetch single column from the next row from a result set More...
	fetchCol ($colnum=0)
	Fetch and return a column from the current row pointer position. More...
	fetchAll ($fetchmode=MDB2_FETCHMODE_DEFAULT, $rekey=false, $force_array=false, $group=false)
	Fetch and return all rows from the current row pointer position. More...
	rowCount ()
	Returns the actual row number that was last fetched (count from 0) More...
	numRows ()
	Returns the number of rows in a result object. More...
	nextResult ()
	Move the internal result pointer to the next available result. More...
	getColumnNames ($flip=false)
	Retrieve the names of columns returned by the DBMS in a query result or from the cache. More...
	_getColumnNames ()
	Retrieve the names of columns returned by the DBMS in a query result. More...
	numCols ()
	Count the number of columns returned by the DBMS in a query result. More...
	getResource ()
	return the resource associated with the result object More...
	bindColumn ($column, &$value, $type=null)
	Set bind variable to a column. More...
	_assignBindColumns ($row)
	Bind a variable to a value in the result row. More...
	free ()
	Free the internal resources associated with result. More...

Data Fields
	$buffer
	$buffer_rownum = - 1
Data Fields inherited from MDB2_Result_Common
	$db
	$result
	$rownum = -1
	$types = array()
	$values = array()
	$offset
	$offset_count = 0
	$limit
	$column_names

Detailed Description

Definition at line 1134 of file oci8.php.

Member Function Documentation

_fillBuffer()

MDB2_BufferedResult_oci8::_fillBuffer

(

$rownum = null

)

Fill the row buffer.

Parameters

int

$rownum

row number upto which the buffer should be filled if the row number is null all rows are ready into the buffer

Returns

boolean true on success, false on failure protected

Definition at line 1149 of file oci8.php.

References $row.

    {
        if (isset($this->buffer) && is_array($this->buffer)) {
            if (is_null($rownum)) {
                if (!end($this->buffer)) {
                    return false;
                }
            } elseif (isset($this->buffer[$rownum])) {
                return (bool)$this->buffer[$rownum];
            }
        }

        $row = true;
        while ((is_null($rownum) || $this->buffer_rownum < $rownum)
            && ($row = @OCIFetchInto($this->result, $buffer, OCI_RETURN_NULLS))
        ) {
            ++$this->buffer_rownum;
            // remove additional column at the end
            if ($this->offset > 0) {
                array_pop($buffer);
            }
            if (empty($this->types)) {
                foreach (array_keys($buffer) as $key) {
                    if (is_a($buffer[$key], 'oci-lob')) {
                        $buffer[$key] = $buffer[$key]->load();
                    }
                }
            }
            $this->buffer[$this->buffer_rownum] = $buffer;
        }

        if (!$row) {
            ++$this->buffer_rownum;
            $this->buffer[$this->buffer_rownum] = false;
            return false;
        }
        return true;
    }

fetchRow()

& MDB2_BufferedResult_oci8::fetchRow	(		$fetchmode = MDB2_FETCHMODE_DEFAULT,
			$rownum = null
	)

Fetch a row and insert the data into an existing array.

Parameters

int	$fetchmode	how the array data should be indexed
int	$rownum	number of the row where the data can be found

Returns

int data array on success, a MDB2 error on failure public

Definition at line 1199 of file oci8.php.

References MDB2_Driver_Common\$fetchmode, $row, PEAR\isError(), MDB2_ERROR_NEED_MORE_DATA, MDB2_FETCHMODE_ASSOC, MDB2_FETCHMODE_DEFAULT, MDB2_FETCHMODE_OBJECT, and MDB2_PORTABILITY_RTRIM.

    {
        if ($this->result === false) {
            $err =& $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
                'resultset has already been freed', __FUNCTION__);
            return $err;
        } elseif (is_null($this->result)) {
            return null;
        }
        if (!is_null($rownum)) {
            $seek = $this->seek($rownum);
            if (PEAR::isError($seek)) {
                return $seek;
            }
        }
        $target_rownum = $this->rownum + 1;
        if ($fetchmode == MDB2_FETCHMODE_DEFAULT) {
            $fetchmode = $this->db->fetchmode;
        }
        if (!$this->_fillBuffer($target_rownum)) {
            $null = null;
            return $null;
        }
        $row = $this->buffer[$target_rownum];
        if ($fetchmode & MDB2_FETCHMODE_ASSOC) {
            $column_names = $this->getColumnNames();
            foreach ($column_names as $name => $i) {
                $column_names[$name] = $row[$i];
            }
            $row = $column_names;
        }
        $mode = 0;
        $rtrim = false;
        if ($this->db->options['portability'] & MDB2_PORTABILITY_RTRIM) {
            if (empty($this->types)) {
                $mode += MDB2_PORTABILITY_RTRIM;
            } else {
                $rtrim = true;
            }
        }
        if ($mode) {
            $this->db->_fixResultArrayValues($row, $mode);
        }
        if (!empty($this->types)) {
            $row = $this->db->datatype->convertResultRow($this->types, $row, $rtrim);
        }
        if (!empty($this->values)) {
            $this->_assignBindColumns($row);
        }
        if ($fetchmode === MDB2_FETCHMODE_OBJECT) {
            $object_class = $this->db->options['fetch_class'];
            if ($object_class == 'stdClass') {
                $row = (object) $row;
            } else {
                $row = &new $object_class($row);
            }
        }
        ++$this->rownum;
        return $row;
    }

Here is the call graph for this function:

free()

MDB2_BufferedResult_oci8::free

(

)

Free the internal resources associated with $result.

Returns

boolean true on success, false if $result is invalid public

Definition at line 1333 of file oci8.php.

    {
        $this->buffer = null;
        $this->buffer_rownum = null;
        return parent::free();
    }

numRows()

MDB2_BufferedResult_oci8::numRows

(

)

Returns the number of rows in a result object.

Returns

mixed MDB2 Error Object or the number of rows public

Definition at line 1312 of file oci8.php.

References MDB2_ERROR_NEED_MORE_DATA.

    {
        if ($this->result === false) {
            return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
                'resultset has already been freed', __FUNCTION__);
        } elseif (is_null($this->result)) {
            return 0;
        }
        $this->_fillBuffer();
        return $this->buffer_rownum;
    }

seek()

MDB2_BufferedResult_oci8::seek

(

$rownum = 0

)

Seek to a specific row in a result set.

Parameters

int

$rownum

number of the row where the data can be found

Returns

mixed MDB2_OK on success, a MDB2 error on failure public

Definition at line 1270 of file oci8.php.

References MDB2_ERROR_NEED_MORE_DATA, and MDB2_OK.

    {
        if ($this->result === false) {
            return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
                'resultset has already been freed', __FUNCTION__);
        }
        $this->rownum = $rownum - 1;
        return MDB2_OK;
    }

valid()

MDB2_BufferedResult_oci8::valid

(

)

Check if the end of the result set has been reached.

Returns

mixed true or false on sucess, a MDB2 error on failure public

Definition at line 1289 of file oci8.php.

References MDB2_ERROR_NEED_MORE_DATA.

    {
        if ($this->result === false) {
            return $this->db->raiseError(MDB2_ERROR_NEED_MORE_DATA, null, null,
                'resultset has already been freed', __FUNCTION__);
        } elseif (is_null($this->result)) {
            return true;
        }
        if ($this->_fillBuffer($this->rownum + 1)) {
            return true;
        }
        return false;
    }

Field Documentation

$buffer

MDB2_BufferedResult_oci8::$buffer

Definition at line 1136 of file oci8.php.

$buffer_rownum

MDB2_BufferedResult_oci8::$buffer_rownum = - 1

Definition at line 1137 of file oci8.php.

---

The documentation for this class was generated from the following file:

• Services/PEAR/lib/MDB2/Driver/oci8.php