Docs For Class MDB2

string apiVersion(
)

Return the MDB2 API version

Return: the MDB2 API version number
Access: public

[ Top ]

mixed &connect(
mixed
$dsn, [array
$options = false])

Create a new MDB2 connection object and connect to the specified database

IMPORTANT: In order for MDB2 to work properly it is necessary that you make sure that you work with a reference of the original object instead of a copy (this is a PHP4 quirk).

For example: $mdb =& MDB2::connect($dsn); ^^ And not: $mdb = MDB2::connect($dsn); ^^

Return: a newly created MDB2 connection object, or a MDB2 error object on error
See: MDB2::parseDSN
Access: public

Parameters:

mixed	`$dsn`	—	'data source name', see the MDB2::parseDSN method for a description of the dsn format. Can also be specified as an array of the format returned by MDB2::parseDSN.
array	`$options`	—	An associative array of option names and their values.

[ Top ]

string errorMessage(
int
$value)

Return a textual error message for a MDB2 error code

Return: error message, or false if the error code was not recognized
Access: public

Parameters:

int $value — error code

[ Top ]

mixed &factory(
string
$type, [mixed
$debug = false])

Create a new MDB2 object for the specified database type type

Return: a newly created MDB2 object, or false on error
Access: public

Parameters:

string $type — database type, for example 'mysql'

[ Top ]

bool isConnection(
mixed
$value)

Tell whether a value is a MDB2 connection

Return: whether $value is a MDB2 connection
Access: public

Parameters:

mixed $value — value to test

[ Top ]

boolean isError(
integer
$value)

Tell whether a result code from a MDB2 method is an error

Return: whether $value is an MDB2 Error Object
Access: public

Parameters:

integer $value — result code

[ Top ]

boolean isManip(
string
$query)

Tell whether a query is a data manipulation query (insert, update or delete) or a data definition query (create, drop, alter, grant, revoke).

Return: whether $query is a data manipulation query
Access: public

Parameters:

string $query — the query

[ Top ]

bool isResult(
mixed
$value)

Tell whether a value is a MDB2 result

Return: whether $value is a MDB2 result
Access: public

Parameters:

mixed $value — value to test

[ Top ]

$module loadFile(
string
$file)

load a file (like 'Date')

Return: name of the file to be included from the MDB2 modules dir
Access: public

Parameters:

string $file — name of the file in the MDB2 directory (without '.php')

[ Top ]

array parseDSN(
string
$dsn)

Parse a data source name

A array with the following keys will be returned: phptype: Database backend used in PHP (mysql, odbc etc.) dbsyntax: Database used with regards to SQL syntax etc. protocol: Communication protocol to use (tcp, unix etc.) hostspec: Host specification (hostname[:port]) database: Database to use on the DBMS server username: User name for login password: Password for login

The format of the supplied DSN is in its fullest form:

phptype(dbsyntax)://username:password@protocol+hostspec/database

Most variations are allowed:

phptype://username:password@protocol+hostspec:110//usr/db_file.db phptype://username:password@hostspec/database_name phptype://username:password@hostspec phptype://username@hostspec phptype://hostspec/database phptype://hostspec phptype(dbsyntax) phptype

Return: an associative array
Author: Tomas V.V.Cox <mailto:cox@idecnet.com>
Access: public

Parameters:

string $dsn — Data Source Name to be parsed

[ Top ]

void setOptions(
object
&$db, array
$options)

set option array in an exiting database object

Access: public

Parameters:

object	`$db`	—	MDB2 object
array	`$options`	—	An associative array of option names and their values.

[ Top ]

mixed &singleton(
[mixed
$dsn = null], [array
$options = false])

Returns a MDB2 connection with the requested DSN.

A newnew MDB2 connection object is only created if no object with the reuested DSN exists yet.

IMPORTANT: In order for MDB2 to work properly it is necessary that you make sure that you work with a reference of the original object instead of a copy (this is a PHP4 quirk).

For example: $mdb =& MDB2::singleton($dsn); ^^ And not: $mdb = MDB2::singleton($dsn); ^^

Return: a newly created MDB2 connection object, or a MDB2 error object on error
See: MDB2::parseDSN
Access: public

Parameters:

mixed	`$dsn`	—	'data source name', see the MDB2::parseDSN method for a description of the dsn format. Can also be specified as an array of the format returned by MDB2::parseDSN.
array	`$options`	—	An associative array of option names and their values.

[ Top ]

Class: MDB2

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

apiVersion [line 386]

connect [line 257]

Parameters:

errorMessage [line 467]

Parameters:

factory [line 207]

Parameters:

isConnection [line 415]

Parameters:

isError [line 401]

Parameters:

isManip [line 446]

Parameters:

isResult [line 429]

Parameters:

loadFile [line 372]

Parameters:

parseDSN [line 551]

Parameters:

setOptions [line 182]

Parameters:

singleton [line 326]

Parameters: