apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
MDB2


Classes:
MDB2
   DB_row
   MDB2_BufferedResult_ibase
   MDB2_BufferedResult_mssql
   MDB2_BufferedResult_mysql
   MDB2_BufferedResult_oci8
   MDB2_BufferedResult_pgsql
   MDB2_BufferedResult_querysim
   MDB2_BufferedResult_sqlite
   MDB2_BufferedResult_xxx
   MDB2_PEARProxy
   MDB2_Result
   MDB2_Result_Common
   MDB2_Result_ibase
   MDB2_Result_mssql
   MDB2_Result_mysql
   MDB2_Result_oci8
   MDB2_Result_pgsql
   MDB2_Result_querysim
   MDB2_Result_sqlite
   MDB2_Result_xxx

Class: MDB2_Result_xxx

Source Location: /MDB2-2.0.0beta2/docs/Driver_skeleton.php

Class Overview

MDB2_Result
   |
   --MDB2_Result_Common
      |
      --MDB2_Result_xxx

Methods

Child classes:

MDB2_BufferedResult_xxx

Inherited Variables

Class: MDB2_Result_Common

MDB2_Result_Common::$mdb
MDB2_Result_Common::$result
MDB2_Result_Common::$rownum
MDB2_Result_Common::$types

Inherited Methods

Class: MDB2_Result_Common

MDB2_Result_Common::MDB2_Result_Common()
Constructor
MDB2_Result_Common::fetch()
fetch value from a result set
MDB2_Result_Common::fetchAll()
Fetch and return a column of data (it uses fetchRow for that)
MDB2_Result_Common::fetchCol()
Fetch and return a column of data (it uses current for that)
MDB2_Result_Common::fetchRow()
Fetch and return a row of data
MDB2_Result_Common::free()
Free the internal resources associated with result.
MDB2_Result_Common::getColumnNames()
Retrieve the names of columns returned by the DBMS in a query result.
MDB2_Result_Common::getResource()
return the resource associated with the result object
MDB2_Result_Common::nextResult()
Move the internal result pointer to the next available result
MDB2_Result_Common::numCols()
Count the number of columns returned by the DBMS in a query result.
MDB2_Result_Common::resultIsNull()
Determine whether the value of a query result located in given row and field is a null.
MDB2_Result_Common::seek()
seek to a specific row in a result set
MDB2_Result_Common::setResultTypes()
Define the list of types to be associated with the columns of a given result set.

Class Details

[line 352]


[ Top ]

Method Detail

MDB2_Result_xxx (Constructor)   [line 360]

MDB2_Result_xxx MDB2_Result_xxx( &$mdb, &$result)

Constructor

Parameters:

   &$mdb   — 
   &$result   — 

[ Top ]

fetch   [line 376]

mixed fetch( [int $rownum = 0], [int $field = 0])

fetch value from a result set
  • Return: string on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Result_Common::fetch() (fetch value from a result set)

Parameters:

int   $rownum   —  number of the row where the data can be found
int   $field   —  field number where the data can be found

[ Top ]

fetchRow   [line 391]

int fetchRow( [int $fetchmode = MDB2_FETCHMODE_DEFAULT])

Fetch a row and insert the data into an existing array.
  • Return: data array on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Result_Common::fetchRow() (Fetch and return a row of data)

Parameters:

int   $fetchmode   —  how the array data should be indexed

[ Top ]

free   [line 477]

boolean free( )

Free the internal resources associated with result.
  • Return: true on success, false if result is invalid
  • Access: public

Overrides MDB2_Result_Common::free() (Free the internal resources associated with result.)
[ Top ]

getColumnNames   [line 416]

mixed getColumnNames( )

Retrieve the names of columns returned by the DBMS in a query result.
  • Return:

    an associative array variable that will hold the names of columns. The indexes of the array are the column names mapped to lower case and the values are the respective numbers of the columns starting from 0. Some DBMS may not return any columns when the result set does not contain any rows.

    a MDB2 error on failure

  • Access: public

Overrides MDB2_Result_Common::getColumnNames() (Retrieve the names of columns returned by the DBMS in a query result.)
[ Top ]

nextResult   [line 463]

true nextResult( )

Move the internal mysql result pointer to the next available result Currently not supported
  • Return: if a result is available otherwise return false
  • Access: public

Overrides MDB2_Result_Common::nextResult() (Move the internal result pointer to the next available result)
[ Top ]

numCols   [line 431]

mixed numCols( )

Count the number of columns returned by the DBMS in a query result.
  • Return: integer value with the number of columns, a MDB2 error on failure
  • Access: public

Overrides MDB2_Result_Common::numCols() (Count the number of columns returned by the DBMS in a query result.)
[ Top ]

resultIsNull   [line 448]

mixed resultIsNull( int $rownum, int $field)

Determine whether the value of a query result located in given row and field is a null.
  • Return: true or false on success, a MDB2 error on failure
  • Access: public

Overrides MDB2_Result_Common::resultIsNull() (Determine whether the value of a query result located in given row and field is a null.)

Parameters:

int   $rownum   —  number of the row where the data can be found
int   $field   —  field number where the data can be found

[ Top ]
Documentation generated on Mon, 11 Mar 2019 10:15:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.