Class DB_msql

Description
Description | Vars (details) | Methods (details)

The methods PEAR DB uses to interact with PHP's msql extension for interacting with Mini SQL databases

These methods overload the ones declared in DB_common.

PHP's mSQL extension did weird things with NULL values prior to PHP 4.3.11 and 5.0.4. Make sure your version of PHP meets or exceeds those versions.

Located in /web/lib/external/pear-db/DB/msql.php (line 54) 

PEAR
   |
   --DB_common
      |
      --DB_msql
Variable Summary
Description | Vars (details) | Methods (details)
resource $connection
string $dbsyntax
array $dsn
array $errorcode_map
array $features
string $phptype
Method Summary
Description | Vars (details) | Methods (details)
void DB_msql ()
int affectedRows ()
int connect (array $dsn, [bool $persistent = false])
int createSequence (string $seq_name)
bool disconnect ()
int dropSequence (string $seq_name)
integer errorCode (string $errormsg)
string errorNative ()
string escapeSimple (string $str)
mixed fetchInto (resource $result,  &$arr, int $fetchmode, [int $rownum = null], array $arr)
bool freeResult (resource $result)
array getSpecialQuery (string $type)
object the msqlRaiseError ([int $errno = null])
int nextId (string $seq_name, [boolean $ondemand = true])
true nextResult (a $result)
int numCols (resource $result)
int numRows (resource $result)
string quoteFloat (float $float)
object a quoteIdentifier (string $str)
mixed simpleQuery (string $query)
array tableInfo (object|string $result, [int $mode = null])
Variables
Description | Vars (details) | Methods (details)
resource $connection (line 104)

The raw database connection created by PHP

string $dbsyntax = 'msql' (line 68)

The database syntax variant to be used (db2, access, etc.), if any

array $dsn = array() (line 110)

The DSN information for connecting to a database

array $errorcode_map = array(
) (line 97)

A mapping of native error codes to DB error codes

array $features = array(
'limit' => 'emulate',
'new_link' => false,
'numrows' => true,
'pconnect' => true,
'prepare' => false,
'ssl' => false,
'transactions' => false,
) (line 83)

The capabilities of this DB implementation

The 'new_link' element contains the PHP version that first provided new_link support for this DBMS. Contains false if it's unsupported.

Meaning of the 'limit' element:

  • 'emulate' = emulate with fetch row by number
  • 'alter' = alter the query
  • false = skip rows

string $phptype = 'msql' (line 62)

The DB driver type (mysql, oci8, odbc, etc.)

Inherited Variables

Inherited from DB_common

DB_common::$fetchmode
 DB_common::$fetchmode_object_class
 DB_common::$last_parameters
 DB_common::$last_query
 DB_common::$options
 DB_common::$prepared_queries
 DB_common::$prepare_tokens
 DB_common::$prepare_types
 DB_common::$was_connected
 DB_common::$_last_query_manip
 DB_common::$_next_query_manip
Methods
Description | Vars (details) Methods (details)
Constructor DB_msql (line 133)

This constructor calls $this->DB_common()

void DB_msql ()
affectedRows (line 416)

Determines the number of rows affected by a data maniuplation query

  1. is returned for queries that don't manipulate data.

  • return: the number of rows. A DB_Error object on failure.
int affectedRows ()
Redefinition of:
DB_common::affectedRows()
Determines the number of rows affected by a data maniuplation query
connect (line 167)

Connect to the database server, log in and open the database

Don't call this method directly. Use DB::connect() instead.

Example of how to connect:

  1.  require_once 'DB.php';
  2.  
  3.  // $dsn = 'msql://hostname/dbname';  // use a TCP connection
  4.  $dsn = 'msql:///dbname';             // use a socket
  5.  $options = array(
  6.      'portability' => DB_PORTABILITY_ALL,
  7.  );
  8.  
  9.  $db = DB::connect($dsn, $options);
  10.  if (PEAR::isError($db)) {
  11.      die($db->getMessage());
  12.  }

  • return: DB_OK on success. A DB_Error object on failure.
int connect (array $dsn, [bool $persistent = false])
  • array $dsn: the data source name
  • bool $persistent: should the connection be persistent?
createSequence (line 485)

Creates a new sequence

Also creates a new table to associate the sequence with. Uses a separate table to ensure portability with other drivers.

int createSequence (string $seq_name)
  • string $seq_name: name of the new sequence
Redefinition of:
DB_common::createSequence()
Creates a new sequence
disconnect (line 225)

Disconnects from the database server

  • return: TRUE on success, FALSE on failure
bool disconnect ()
dropSequence (line 510)

Deletes a sequence

int dropSequence (string $seq_name)
  • string $seq_name: name of the sequence to be deleted
Redefinition of:
DB_common::dropSequence()
Deletes a sequence
errorCode (line 614)

Determines PEAR::DB error code from the database's text error message

  • return: the error number from a DB_ERROR* constant
integer errorCode (string $errormsg)
  • string $errormsg: the error message returned from the database
Redefinition of:
DB_common::errorCode()
Maps native error codes to DB's portable ones
errorNative (line 599)

Gets the DBMS' native error message produced by the last query

  • return: the DBMS' error message
string errorNative ()
Redefinition of:
DB_common::errorNative()
Gets the DBMS' native error code produced by the last query
escapeSimple (line 562)

Escapes a string according to the current DBMS's standards

string escapeSimple (string $str)
  • string $str: the string to be escaped
Redefinition of:
DB_common::escapeSimple()
Escapes a string according to the current DBMS's standards
fetchInto (line 308)

Places a row from the result set into the given array

Formating of the array and the data therein are configurable. See DB_result::fetchInto() for more information.

This method is not meant to be called directly. Use DB_result::fetchInto() instead. It can't be declared "protected" because DB_result is a separate object.

PHP's mSQL extension did weird things with NULL values prior to PHP 4.3.11 and 5.0.4. Make sure your version of PHP meets or exceeds those versions.

  • return: DB_OK on success, NULL when the end of a result set is reached or on failure
  • see: DB_result::fetchInto()
mixed fetchInto (resource $result,  &$arr, int $fetchmode, [int $rownum = null], array $arr)
  • resource $result: the query result resource
  • array $arr: the referenced array to put the data in
  • int $fetchmode: how the resulting array should be indexed
  • int $rownum: the row number to fetch (0 = first row)
  • &$arr
freeResult (line 351)

Deletes the result set and frees the memory occupied by the result set

This method is not meant to be called directly. Use DB_result::free() instead. It can't be declared "protected" because DB_result is a separate object.

bool freeResult (resource $result)
  • resource $result: PHP's query result resource
getSpecialQuery (line 797)

Obtain a list of a given type of objects

array getSpecialQuery (string $type)
  • string $type: the kind of objects you want to retrieve
Redefinition of:
DB_common::getSpecialQuery()
Obtains the query string needed for listing a given type of objects
msqlRaiseError (line 582)

Produces a DB_Error object regarding the current problem

object the msqlRaiseError ([int $errno = null])
  • int $errno: if the error is being manually raised pass a DB_ERROR* constant here. If this isn't passed the error information gathered from the DBMS.
nextId (line 440)

Returns the next free id in a sequence

int nextId (string $seq_name, [boolean $ondemand = true])
  • string $seq_name: name of the sequence
  • boolean $ondemand: when true, the seqence is automatically created if it does not exist
Redefinition of:
DB_common::nextId()
Returns the next free id in a sequence
nextResult (line 276)

Move the internal msql result pointer to the next available result

  • return: if a result is available otherwise return false
  • access: public
true nextResult (a $result)
  • a $result: valid fbsql result resource
numCols (line 372)

Gets the number of columns in a result set

This method is not meant to be called directly. Use DB_result::numCols() instead. It can't be declared "protected" because DB_result is a separate object.

int numCols (resource $result)
  • resource $result: PHP's query result resource
numRows (line 397)

Gets the number of rows in a result set

This method is not meant to be called directly. Use DB_result::numRows() instead. It can't be declared "protected" because DB_result is a separate object.

int numRows (resource $result)
  • resource $result: PHP's query result resource
Redefinition of:
DB_common::numRows()
Determines the number of rows in a query result
quoteFloat (line 545)

Formats a float value for use within a query in a locale-independent manner.

string quoteFloat (float $float)
  • float $float: the float value to be quoted.
Redefinition of:
DB_common::quoteFloat()
Formats a float value for use within a query in a locale-independent manner.
quoteIdentifier (line 528)

mSQL does not support delimited identifiers

object a quoteIdentifier (string $str)
  • string $str: the identifier name to be quoted
Redefinition of:
DB_common::quoteIdentifier()
Quotes a string so it can be safely used as a table or column name
simpleQuery (line 244)

Sends a query to the database server

  • return: + a PHP result resrouce for successful SELECT queries
    • the DB_OK constant for other successful queries
    • a DB_Error object on failure
mixed simpleQuery (string $query)
  • string $query: the SQL query string
tableInfo (line 705)

Returns information about a table or a result set

  • return: an associative array with the information requested. A DB_Error object on failure.
  • see: DB_common::setOption()
array tableInfo (object|string $result, [int $mode = null])
  • object|string $result: DB_result object from a query or a string containing the name of a table. While this also accepts a query result resource identifier, this behavior is deprecated.
  • int $mode: a valid tableInfo mode
Redefinition of:
DB_common::tableInfo()
Returns information about a table or a result set

Inherited Methods

Inherited From DB_common

DB_common::DB_common()
DB_common::affectedRows()
DB_common::autoCommit()
DB_common::autoExecute()
DB_common::autoPrepare()
DB_common::buildManipSQL()
DB_common::commit()
DB_common::createSequence()
DB_common::dropSequence()
DB_common::errorCode()
DB_common::errorMessage()
DB_common::errorNative()
DB_common::escapeSimple()
DB_common::execute()
DB_common::executeEmulateQuery()
DB_common::executeMultiple()
DB_common::freePrepared()
DB_common::getAll()
DB_common::getAssoc()
DB_common::getCol()
DB_common::getListOf()
DB_common::getOne()
DB_common::getOption()
DB_common::getRow()
DB_common::getSequenceName()
DB_common::getSpecialQuery()
DB_common::getTables()
DB_common::limitQuery()
DB_common::modifyLimitQuery()
DB_common::modifyQuery()
DB_common::nextId()
DB_common::nextQueryIsManip()
DB_common::numRows()
DB_common::prepare()
DB_common::provides()
DB_common::query()
DB_common::quote()
DB_common::quoteBoolean()
DB_common::quoteFloat()
DB_common::quoteIdentifier()
DB_common::quoteSmart()
DB_common::quoteString()
DB_common::raiseError()
DB_common::rollback()
DB_common::setFetchMode()
DB_common::setOption()
DB_common::tableInfo()
DB_common::toString()
DB_common::_checkManip()
DB_common::_convertNullArrayValuesToEmpty()
DB_common::_rtrimArrayValues()
DB_common::__sleep()
DB_common::__toString()
DB_common::__wakeup()

Inherited From PEAR

PEAR::PEAR()
PEAR::delExpect()
PEAR::expectError()
PEAR::getStaticProperty()
PEAR::isError()
PEAR::loadExtension()
PEAR::popErrorHandling()
PEAR::popExpect()
PEAR::pushErrorHandling()
PEAR::raiseError()
PEAR::registerShutdownFunc()
PEAR::setErrorHandling()
PEAR::staticPopErrorHandling()
PEAR::staticPushErrorHandling()
PEAR::throwError()
PEAR::_PEAR()

Documentation generated on Wed, 09 Feb 2011 09:01:55 +0700 by phpDocumentor 1.4.2