Class: DB_msql

Source Location: /DB-1.7.7/DB/msql.php

Class Overview

PEAR
   |
   --DB_common
      |
      --DB_msql

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

Author(s):

Daniel Convissor <danielc at php.net>

Version:

Release: @package_version@

Copyright:

1997-2005 The PHP Group

Variables

Methods

Inherited Variables

Class: 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

Inherited Methods

Class: DB_common

DB_common::DB_common(): This constructor calls $this->PEAR('DB_Error')
DB_common::affectedRows(): Determines the number of rows affected by a data maniuplation query
DB_common::autoCommit(): Enables or disables automatic commits
DB_common::autoExecute(): Automaticaly generates an insert or update query and call prepare() and execute() with it
DB_common::autoPrepare(): Automaticaly generates an insert or update query and pass it to prepare()
DB_common::buildManipSQL(): Produces an SQL query string for autoPrepare()
DB_common::commit(): Commits the current transaction
DB_common::createSequence(): Creates a new sequence
DB_common::dropSequence(): Deletes a sequence
DB_common::errorCode(): Maps native error codes to DB's portable ones
DB_common::errorMessage(): Maps a DB error code to a textual message
DB_common::errorNative(): Gets the DBMS' native error code produced by the last query
DB_common::escapeSimple(): Escapes a string according to the current DBMS's standards
DB_common::execute(): Executes a DB statement prepared with prepare()
DB_common::executeEmulateQuery(): Emulates executing prepared statements if the DBMS not support them
DB_common::executeMultiple(): Performs several execute() calls on the same statement handle
DB_common::freePrepared(): Frees the internal resources associated with a prepared query
DB_common::getAll(): Fetches all of the rows from a query result
DB_common::getAssoc(): Fetches an entire query result and returns it as an associative array using the first column as the key
DB_common::getCol(): Fetches a single column from a query result and returns it as an indexed array
DB_common::getListOf(): Lists internal database information
DB_common::getOne(): Fetches the first column of the first row from a query result
DB_common::getOption(): Returns the value of an option
DB_common::getRow(): Fetches the first row of data returned from a query result
DB_common::getSequenceName(): Generates the name used inside the database for a sequence
DB_common::getSpecialQuery(): Obtains the query string needed for listing a given type of objects
DB_common::getTables(): Lists the tables in the current database
DB_common::limitQuery(): Generates and executes a LIMIT query
DB_common::modifyLimitQuery(): Adds LIMIT clauses to a query string according to current DBMS standards
DB_common::modifyQuery(): Changes a query string for various DBMS specific reasons
DB_common::nextId(): Returns the next free id in a sequence
DB_common::numRows(): Determines the number of rows in a query result
DB_common::prepare(): Prepares a query for multiple execution with execute()
DB_common::provides(): Tells whether the present driver supports a given feature
DB_common::query(): Sends a query to the database server
DB_common::quote(): DEPRECATED: Quotes a string so it can be safely used in a query
DB_common::quoteIdentifier(): Quotes a string so it can be safely used as a table or column name
DB_common::quoteSmart(): Formats input so it can be safely used in a query
DB_common::quoteString(): DEPRECATED: Quotes a string so it can be safely used within string delimiters in a query
DB_common::raiseError(): Communicates an error and invoke error callbacks, etc
DB_common::rollback(): Reverts the current transaction
DB_common::setFetchMode(): Sets the fetch mode that should be used by default for query results
DB_common::setOption(): Sets run-time configuration options for PEAR DB
DB_common::tableInfo(): Returns information about a table or a result set
DB_common::toString(): DEPRECATED: String conversion method
DB_common::_convertNullArrayValuesToEmpty(): Converts all null values in an array to empty strings
DB_common::_rtrimArrayValues(): Right-trims all strings in an array
DB_common::__sleep(): Automatically indicates which properties should be saved when PHP's serialize() function is called
DB_common::__toString(): Automatic string conversion for PHP 5
DB_common::__wakeup(): Automatically reconnects to the database when PHP's unserialize() function is called

Class Details

[line 54]
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.

Link: http://pear.php.net/package/DB
Since: Class not functional until Release 1.7.0
Version: Release: @package_version@
License: PHP License 3.0
Copyright: 1997-2005 The PHP Group
Author: Daniel Convissor <danielc@php.net>

[ Top ]

Class Variables

$connection =

[line 104]

The raw database connection created by PHP

Type:

resource

[ Top ]

$dbsyntax = 'msql'

[line 68]

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

Type:

string

[ Top ]

$dsn = array()

[line 110]

The DSN information for connecting to a database

Type:

array

[ Top ]

$errorcode_map = array(
)

[line 97]

A mapping of native error codes to DB error codes

Type:

array

[ Top ]

$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

Type:

array

[ Top ]

$phptype = 'msql'

[line 62]

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

Type:

string

[ Top ]

Method Detail

DB_msql (Constructor) [line 133]

void DB_msql(
)

This constructor calls $this->DB_common()

[ Top ]

affectedRows [line 416]

int affectedRows(
)

Determines the number of rows affected by a data maniuplation query

is returned for queries that don't manipulate data.

Return: the number of rows. A DB_Error object on failure.

Overrides DB_common::affectedRows() (Determines the number of rows affected by a data maniuplation query)

[ Top ]

connect [line 167]

int connect(
array
$dsn, [bool
$persistent = false])

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:

 require_once 'DB.php';

 
 // $dsn = 'msql://hostname/dbname';  // use a TCP connection
  $dsn = 'msql:///dbname';             // use a socket
  $options = array(
     'portability' => DB_PORTABILITY_ALL,
 );
 
 $db =& DB::connect($dsn, $options);
 if (PEAR::isError($db)) {
     die($db->getMessage());
 }

Return: DB_OK on success. A DB_Error object on failure.

Parameters:

array	`$dsn`	—	the data source name
bool	`$persistent`	—	should the connection be persistent?

[ Top ]

createSequence [line 485]

int createSequence(
string
$seq_name)

Creates a new sequence

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

Return: DB_OK on success. A DB_Error object on failure.
See: DB_common::createSequence(), DB_common::getSequenceName(), DB_msql::nextID(), DB_msql::dropSequence()

Overrides DB_common::createSequence() (Creates a new sequence)

Parameters:

string $seq_name — name of the new sequence

[ Top ]

disconnect [line 225]

bool disconnect(
)

Disconnects from the database server

Return: TRUE on success, FALSE on failure

[ Top ]

dropSequence [line 510]

int dropSequence(
string
$seq_name)

Deletes a sequence

Return: DB_OK on success. A DB_Error object on failure.
See: DB_common::dropSequence(), DB_common::getSequenceName(), DB_msql::nextID(), DB_msql::createSequence()

Overrides DB_common::dropSequence() (Deletes a sequence)

Parameters:

string $seq_name — name of the sequence to be deleted

[ Top ]

errorCode [line 598]

integer errorCode(
string
$errormsg)

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

Return: the error number from a DB_ERROR* constant

Overrides DB_common::errorCode() (Maps native error codes to DB's portable ones)

Parameters:

string $errormsg — the error message returned from the database

[ Top ]

errorNative [line 583]

string errorNative(
)

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

Return: the DBMS' error message

Overrides DB_common::errorNative() (Gets the DBMS' native error code produced by the last query)

[ Top ]

escapeSimple [line 546]

string escapeSimple(
string
$str)

Escapes a string according to the current DBMS's standards

Return: the escaped string
Since: Method available since Release 1.7.0
See: DB_common::quoteSmart()

Overrides DB_common::escapeSimple() (Escapes a string according to the current DBMS's standards)

Parameters:

string $str — the string to be escaped

[ Top ]

fetchInto [line 308]

mixed fetchInto(
resource
$result, 
&$arr, int
$fetchmode, [int
$rownum = null], array
$arr)

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()

Parameters:

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`	—

[ Top ]

freeResult [line 351]

bool freeResult(
resource
$result)

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.

Return: TRUE on success, FALSE if $result is invalid
See: DB_result::free()

Parameters:

resource $result — PHP's query result resource

[ Top ]

getSpecialQuery [line 781]

array getSpecialQuery(
string
$type)

Obtain a list of a given type of objects

Return: the array containing the list of objects requested
See: DB_common::getListOf()
Access: protected

Overrides DB_common::getSpecialQuery() (Obtains the query string needed for listing a given type of objects)

Parameters:

string $type — the kind of objects you want to retrieve

[ Top ]

msqlRaiseError [line 566]

object the msqlRaiseError(
[int
$errno = null])

Produces a DB_Error object regarding the current problem

Return: DB_Error object
See: DB_common::raiseError(), DB_msql::errorNative(), DB_msql::errorCode()

Parameters:

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.

[ Top ]

nextId [line 440]

int nextId(
string
$seq_name, [boolean
$ondemand = true])

Returns the next free id in a sequence

Return: the next id number in the sequence. A DB_Error object on failure.
See: DB_common::nextID(), DB_common::getSequenceName(), DB_msql::createSequence(), DB_msql::dropSequence()

Overrides DB_common::nextId() (Returns the next free id in a sequence)

Parameters:

string	`$seq_name`	—	name of the sequence
boolean	`$ondemand`	—	when true, the seqence is automatically created if it does not exist

[ Top ]

nextResult [line 276]

true nextResult(
a
$result)

Move the internal msql result pointer to the next available result

Return: if a result is available otherwise return false
Access: public

Parameters:

a $result — valid fbsql result resource

[ Top ]

numCols [line 372]

int numCols(
resource
$result)

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.

Return: the number of columns. A DB_Error object on failure.
See: DB_result::numCols()

Parameters:

resource $result — PHP's query result resource

[ Top ]

numRows [line 397]

int numRows(
resource
$result)

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.

Return: the number of rows. A DB_Error object on failure.
See: DB_result::numRows()

Overrides DB_common::numRows() (Determines the number of rows in a query result)

Parameters:

resource $result — PHP's query result resource

[ Top ]

quoteIdentifier [line 528]

object a quoteIdentifier(
string
$str)

mSQL does not support delimited identifiers

Return: DB_Error object
Since: Method available since Release 1.7.0
See: DB_common::quoteIdentifier()

Overrides DB_common::quoteIdentifier() (Quotes a string so it can be safely used as a table or column name)

Parameters:

string $str — the identifier name to be quoted

[ Top ]

simpleQuery [line 244]

mixed simpleQuery(
string
$query)

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

Parameters:

string $query — the SQL query string

[ Top ]

tableInfo [line 689]

array tableInfo(
object|string
$result, [int
$mode = null])

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()

Overrides DB_common::tableInfo() (Returns information about a table or a result set)

Parameters:

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

[ Top ]

Class: DB_msql

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: DB_common

Inherited Methods

Class: DB_common

Class Details

Class Variables

$connection =

$dbsyntax = 'msql'

$dsn = array()

$errorcode_map = array( )

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

$phptype = 'msql'

Method Detail

DB_msql (Constructor) [line 133]

affectedRows [line 416]

connect [line 167]

Parameters:

createSequence [line 485]

Parameters:

disconnect [line 225]

dropSequence [line 510]

Parameters:

errorCode [line 598]

Parameters:

errorNative [line 583]

escapeSimple [line 546]

Parameters:

fetchInto [line 308]

Parameters:

freeResult [line 351]

Parameters:

getSpecialQuery [line 781]

Parameters:

msqlRaiseError [line 566]

Parameters:

nextId [line 440]

Parameters:

nextResult [line 276]

Parameters:

numCols [line 372]

Parameters:

numRows [line 397]

Parameters:

quoteIdentifier [line 528]

Parameters:

simpleQuery [line 244]

Parameters:

tableInfo [line 689]

Parameters:

$errorcode_map = array(
)

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