Class: VDBI

static string|false getDefaultDatabaseName( )

[line 175]

Get default database name

Tags:

• return - Database name or false if none provided
• access - public

Parameters:

static DBI &getInstance( )

[line 158]

Get instance of DBI object

Tags:

• return - Object
• access - public

Parameters:

VDBI __construct( )

[line 441]

Class constructor

Tags:

• access - public

Overridden in child classes as:

VDatabase::__construct()

Class constructor

VMssqlDatabase::__construct()

Class constructor

VMssqlTable::__construct()

Class constructor

VMysqlDatabase::__construct()

Class constructor

VMysqlQuery::__construct()

Class constructor

VMysqlTable::__construct()

Class constructor

Overrides VObject::__construct() (Class Constructor)

Parameters:

void &createTable( string $tableId, string $tableName, string $schema, string $schemaSource, [string $databaseName = null])

[line 319]

Create Table

Create a table from a schema

Tags:

• access - public

Overridden in child classes as:

VMysqlDatabase::createTable()

Create Table

Parameters:

• string $tableId - Table ID
• string $tableName - Table name
• string $schema - Schema
• string $schemaSource - Source of schema
• string $databaseName - Database name

VDatabase &getDatabase( [string $databaseName = null])

[line 191]

Get a database object

Tags:

• return - Database on success, error or warning on failure
• access - public

Parameters:

• string $databaseName -

object Row &getRow( mixed $key, [string $tableName = null], [string $databaseName = null])

[line 338]

Get a row from a table

Tags:

• return - object on success, error or warning on failure
• access - public

Overridden in child classes as:

VDatabase::getRow()

Get a row from a table

VMssqlDatabase::getRow()

Get a row from a table

VMssqlTable::getRow()

Get a row from a table

VMysqlDatabase::getRow()

Get a row from a table

VMysqlQuery::getRow()

Get a row from a query

VMysqlTable::getRow()

Get a row from a table

Parameters:

• mixed $key - Row identifier (primary key value)
• string $tableName - Table name
• string $databaseName - Database name

object Table &getTable( string $tableName, [string $databaseName = null])

[line 297]

Get database table

Tags:

• return - object on success, error or warning on failure
• access - public

Overridden in child classes as:

VDatabase::getTable()

Get database table

VMssqlDatabase::getTable()

Get database table

VMysqlDatabase::getTable()

Get database table

Parameters:

• string $tableName - Table Name
• string $databaseName - Database name

boolean isError( $val)

[line 100]

Test if a value is an error

Tags:

• return - True if error, false otherwise
• access - public

Parameters:

• $val -

boolean isWarning( $val)

[line 112]

Test if a value is a warning

Tags:

• return - True if error, false otherwise
• access - public

Parameters:

• $val -

array|object Database listDatabases( )

[line 415]

List databases

Tags:

• return - names on success, error or warning on failure
• access - public

Parameters:

array|object Database listDBTypes( )

[line 390]

Get list of supported database types

Tags:

• return - types on success, error or warning on failure
• access - public

Parameters:

array|object Table listTables( [string $databaseName = null])

[line 264]

List database tables

Tags:

• return - names on success, error or warning on failure
• access - public

Overridden in child classes as:

VMssqlDatabase::listTables()

List database tables

VMysqlDatabase::listTables()

List database tables

Parameters:

• string $databaseName - Database name

void loadDatabases( )

[line 370]

Load databases

Tags:

• access - public

Parameters:

integer lock( &$lock, integer $lock)

[line 235]

Lock a section of code

Tags:

• return - Original lock value
• access - public

Parameters:

• integer $lock - Lock variable
• &$lock -

string nameQuote( string $name)

[line 75]

Quote a database identifier

Tags:

• return - Quoted string
• access - public

Overridden in child classes as:

VMssqlDatabase::nameQuote()

Quote a database identifier

VMysqlDatabase::nameQuote()

Quote a database identifier

Parameters:

• string $name - Identifier

string quote( $val, string $name)

[line 88]

Quote a database value

Tags:

• return - Quoted string
• access - public

Overridden in child classes as:

VMssqlDatabase::quote()

Quote a database value

VMysqlDatabase::quote()

Quote a database value

Parameters:

• string $name - Identifier
• $val -

VError raiseError( string $errmsg, [integer $errno = null], [boolean $throw = true])

[line 127]

Generate an error

Tags:

• return - Error
• access - public

Parameters:

• string $errmsg - Error message
• integer $errno - Error code
• boolean $throw - Send error message immediatly

VWarning raiseWarning( string $errmsg, integer $errno, [boolean $throw = true])

[line 143]

Generate a warning

Tags:

• return - Warning
• access - public

Parameters:

• string $errmsg - Warning message
• integer $errno - Error code
• boolean $throw - Send warning message immediatly

integer unlock( &$lock, integer $lock)

[line 249]

UnLock a section of code

Tags:

• return - Original lock value

Parameters:

• integer $lock - Lock variable
• &$lock -