Child classes:
- VMssqlDatabase
- Virtual Web Platform - MsSQL Database support
- VMysqlDatabase
- Virtual Web Platform - MySQL Database support
Inherited Variables
Inherited Constants
Inherited Methods
Class: VDBI
- VDBI::__construct()
- Class constructor
- VDBI::createTable()
- Create Table
- VDBI::getDatabase()
- Get a database object
- VDBI::getDefaultDatabaseName()
- Get default database name
- VDBI::getInstance()
- Get instance of DBI object
- VDBI::getRow()
- Get a row from a table
- VDBI::getTable()
- Get database table
- VDBI::isError()
- Test if a value is an error
- VDBI::isWarning()
- Test if a value is a warning
- VDBI::listDatabases()
- List databases
- VDBI::listDBTypes()
- Get list of supported database types
- VDBI::listTables()
- List database tables
- VDBI::loadDatabases()
- Load databases
- VDBI::lock()
- Lock a section of code
- VDBI::nameQuote()
- Quote a database identifier
- VDBI::quote()
- Quote a database value
- VDBI::raiseError()
- Generate an error
- VDBI::raiseWarning()
- Generate a warning
- VDBI::unlock()
- UnLock a section of code
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__toString()
- Return object as a string
Class Details
Virtual Web Platform - DBI Database support
This Class provides the base class for all databases
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$_connected = false
[line 65]
Tags:
- var - Connection status
- access - protected
Type: boolean
Overrides:
[ Top ]
$_db_class
[line 89]
Tags:
- var - Database Class
- access - protected
Type: string
Overrides:
[ Top ]
$_db_classfile
[line 96]
Tags:
- var - Database Class
- access - protected
Type: string
Overrides:
[ Top ]
$_link
[line 49]
Tags:
- var - Database connection
- access - protected
Type: mixed
Overrides:
[ Top ]
$_protected_prefix = "db"
[line 81]
Tags:
- var - Protected variable name prefix
- access - protected
Type: string
Overrides:
[ Top ]
$_query
[line 105]
Stored database Query
Tags:
- var - Database query
- access - protected
Type: string
Overrides:
[ Top ]
$_tables = array()
[line 57]
Tags:
- var - Database table cache
- access - protected
Type: array
Overrides:
[ Top ]
$_tables_loaded = false
[line 73]
Tags:
- var - Tables in cache flag
- access - protected
Type: boolean
Overrides:
[ Top ]
Class Methods
__construct
VDatabase __construct(
)
[line 275]
Class constructor
Tags:
- access - public
Overridden in child classes as:
- VMssqlDatabase::__construct()
- Class constructor
- VMssqlTable::__construct()
- Class constructor
- VMysqlDatabase::__construct()
- Class constructor
- VMysqlQuery::__construct()
- Class constructor
- VMysqlTable::__construct()
- Class constructor
Overrides VDBI::__construct() (Class constructor)
Parameters:
[ Top ]
connect
boolean connect(
)
[line 153]
Connect to database
Tags:
- return - True on success
- access - public
Parameters:
[ Top ]
createQuery
object Query &createQuery(
)
[line 248]
Create Query
Tags:
- return - Object on success, error or warning otherwise
- access - public
Overridden in child classes as:
- VMysqlDatabase::createQuery()
- Create Query
Parameters:
[ Top ]
disconnect
boolean disconnect(
)
[line 171]
Disconnect from database
Tags:
- return - True on success
- access - public
Parameters:
[ Top ]
drop
true|object True drop(
)
[line 141]
Drop database
Tags:
- return - on success, error or warning on failure
Parameters:
[ Top ]
getDBType
string getDBType(
)
[line 114]
Get database type
Tags:
- return - Database type
- access - public
Parameters:
[ Top ]
getRow
object Row &getRow(
mixed
$key, [string
$tableName = null], [string
$databaseName = null])
[line 202]
Get a row from a table
Tags:
- return - object on success, error or warning on failure
- access - public
Overridden in child classes as:
- 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
Overrides VDBI::getRow() (Get a row from a table)
Parameters:
- mixed $key - Row identifier (primary key value)
- string $tableName - Table name
- string $databaseName - Database name
[ Top ]
getTable
object Table &getTable(
string
$tableName, [string
$databaseName = null])
[line 187]
Get database table
Tags:
- return - object on success, error or warning on failure
- access - public
Overridden in child classes as:
- VMssqlDatabase::getTable()
- Get database table
- VMysqlDatabase::getTable()
- Get database table
Overrides VDBI::getTable() (Get database table)
Parameters:
- string $tableName - Table Name
- string $databaseName - Database name
[ Top ]
loadTables
true|object True loadTables(
)
[line 235]
Load tables
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
[ Top ]
setQuery
true|object True setQuery(
string
$query)
[line 129]
Set database query string
Tags:
- return - on success, error or warning on failure
Parameters:
- string $query - Database query
[ Top ]
unloadTables
true|object True unloadTables(
)
[line 262]
UnLoad tables
Clears table cache
Tags:
- return - on success, error or warning otherwise
- access - public
Parameters:
[ Top ]