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: $db =& MDB2::connect($dsn); ^^ And not: $db = 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(
mixed
$dsn, [array
$options = false])

Create a new MDB2 object for the specified database type

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: $db =& MDB2::factory($dsn); ^^ And not: $db = MDB2::factory($dsn);

Return: a newly created MDB2 object, or false on error
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 ]

boolean fileExists(
string
$file)

checks if a file exists in the include path

Return: true success and false on error
Access: public

Parameters:

string $file — filename

[ 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 ]

bool isError(
mixed
$data, [int
$code = null])

Tell whether a value is a MDB2 error.

Return: true if parameter is an error
Access: public

Parameters:

mixed	`$data`	—	the value to test
int	`$code`	—	if $data is an error object, return true only if $code is a string and $db->getMessage() == $code or $code is an integer and $db->getCode() == $code

[ 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 ]

bool isResultCommon(
mixed
$value)

Tell whether a value is a MDB2 result implementing the common interface

Return: whether $value is a MDB2 result implementing the common interface
Access: public

Parameters:

mixed $value — value to test

[ Top ]

bool isStatement(
mixed
$value)

Tell whether a value is a MDB2 statement interface

Return: whether $value is a MDB2 statement interface
Access: public

Parameters:

mixed $value — value to test

[ Top ]

string loadFile(
string
$file)

load a file (like 'Date')

Return: name of the file that was included
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.

Additional keys can be added by appending a URI query string to the end of the DSN.

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


1     phptype(dbsyntax):

Most variations are allowed:


1     phptype://username:password@protocol+hostspec:110//usr/db_file.db?mode=0644
2       phptype://username:password@hostspec/database_name
3       phptype://username:password@hostspec
4       phptype://username@hostspec
5       phptype://hostspec/database
6       phptype://hostspec
7       phptype(dbsyntax)
8       phptype

Return: an associative array with the following keys:
- 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
Author: Tomas V.V.Cox <mailto:cox@idecnet.com>

Parameters:

string $dsn — Data Source Name to be parsed

[ Top ]

object a &raiseError(
[mixed
$code = null], [int
$mode = null], [mixed
$options = null], [string
$userinfo = null])

This method is used to communicate an error and invoke error callbacks etc. Basically a wrapper for PEAR::raiseError without the message string.

Return: PEAR error object
See: PEAR_Error

Parameters:

mixed	`$code`	—	integer error code
int	`$mode`	—	error mode, see PEAR_Error docs
mixed	`$options`	—	If error mode is PEAR_ERROR_TRIGGER, this is the error level (E_USER_NOTICE etc). If error mode is PEAR_ERROR_CALLBACK, this is the callback function, either as a function name, or as an array of an object and method name. For other error modes this parameter is ignored.
string	`$userinfo`	—	Extra debug information. Defaults to the last query and native error code.

[ Top ]

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

set option array in an exiting database object

Access: public

Parameters:

MDB2_Driver_Common	`$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: $db =& MDB2::singleton($dsn); ^^ And not: $db = 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 486]

connect [line 384]

Parameters:

errorMessage [line 619]

Parameters:

factory [line 317]

Parameters:

fileExists [line 828]

Parameters:

isConnection [line 561]

Parameters:

isError [line 537]

Parameters:

isResult [line 575]

Parameters:

isResultCommon [line 589]

Parameters:

isStatement [line 603]

Parameters:

loadFile [line 463]

Parameters:

parseDSN [line 707]

Parameters:

raiseError [line 517]

Parameters:

setOptions [line 279]

Parameters:

singleton [line 432]

Parameters: