Class: VDBI

Source Location: /libraries/vwp/dbi/dbi.php

Class Overview [line 59]

VType
   |
   --VObject
      |
      --VDBI

Virtual Web Platform - DBI Database API

Author(s):

Version:

Copyright:

  • (c) Ralph Ritoch - All Rights Reserved

Variables

Constants

Methods


Child classes:

VDatabase
Virtual Web Platform - DBI Database support

Inherited Variables

Inherited Constants

Inherited Methods

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::__get()
VObject::__isset()
VObject::__set()
VObject::__toString()
Return object as a string
VObject::__unset()


Class Details

Virtual Web Platform - DBI Database API

This class provides the primary access point for the default database API. This class is extended by the VDatabase class to provide core database access features for all database types.

Tags:

[ Top ]


Class Variables


Class Methods

static getDefaultDatabaseName

static string|false getDefaultDatabaseName( )

[line 188]

Get default database name

Tags:

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

Parameters:

[ Top ]

static getInstance

static DBI &getInstance( )

[line 171]

Get instance of DBI object

Tags:

  • return - Object
  • access - public

Parameters:

[ Top ]

__construct

VDBI __construct( )

[line 467]

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:

[ Top ]

createQuery

void &createQuery( )

[line 455]

Create Query

Tags:

  • access - public

Overridden in child classes as:

VDatabase::createQuery()
Create Query
VMysqlDatabase::createQuery()
Create Query

Parameters:

[ Top ]

createTable

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

[line 333]

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

[ Top ]

getDatabase

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

[line 204]

Get a database object

Tags:

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

Parameters:

  • string $databaseName -

[ Top ]

getRow

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

[line 352]

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

[ Top ]

getTable

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

[line 311]

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

[ Top ]

isError

boolean isError( $val)

[line 113]

Test if a value is an error

Tags:

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

Parameters:

  • $val -

[ Top ]

isWarning

boolean isWarning( $val)

[line 125]

Test if a value is a warning

Tags:

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

Parameters:

  • $val -

[ Top ]

listDatabases

array|object Database listDatabases( )

[line 429]

List databases

Tags:

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

Parameters:

[ Top ]

listDBTypes

array|object Database listDBTypes( )

[line 404]

Get list of supported database types

Tags:

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

Parameters:

[ Top ]

listTables

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

[line 278]

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

[ Top ]

loadDatabases

void loadDatabases( )

[line 384]

Load databases

Tags:

  • access - public

Parameters:

[ Top ]

lock

integer lock( &$lock, integer $lock)

[line 249]

Lock a section of code

Tags:

  • return - Original lock value
  • access - public

Parameters:

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

[ Top ]

nameQuote

string nameQuote( string $name)

[line 88]

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

[ Top ]

quote

string quote( $val, string $name)

[line 101]

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 -

[ Top ]

raiseError

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

[line 140]

Generate an error

Tags:

  • return - Error
  • access - public

Parameters:

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

[ Top ]

raiseWarning

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

[line 156]

Generate a warning

Tags:

  • return - Warning
  • access - public

Parameters:

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

[ Top ]

unlock

integer unlock( &$lock, integer $lock)

[line 263]

UnLock a section of code

Tags:

  • return - Original lock value

Parameters:

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

[ Top ]


Class Constants


Documentation generated on Sun, 06 Mar 2011 02:21:54 -0600 by phpDocumentor 1.4.3