Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions
DbBackendPlugin Class Reference
Inheritance diagram for DbBackendPlugin:
DbBackend_MatrixDAL

Public Member Functions

 connect ($conn_string)
 
 disconnect ()
 
 execute ($sql)
 
 getDbName ()
 
 getDbType ()
 
 getDbVersion ()
 
 getTableNames ()
 
 getColumnNames ($table)
 
 matchesMacro ($s)
 

Detailed Description

Abstract class for DB backend plugins.

Author
Daniel Simmons dan@d.nosp@m.ans..nosp@m.im 2010 Daniel Simmons http://www.opensource.org/licenses/mit-license.php

Definition at line 2083 of file matrixsqlclient.php.

Member Function Documentation

connect (   $conn_string)
abstract

Connects to the host/database.

Parameters
string$conn_stringConnection string/DSN for connecting to the database.
Returns
boolean true on success, false on failure
disconnect ( )
abstract

Disconnect from the database/host.

Returns
boolean true on success, false on failure
execute (   $sql)
abstract

Execute the specified SQL/commands on the database.

Parameters
string$sqlThe SQL/command to send to the database.
Returns
mixed string or array of returned data, or false on failure
getColumnNames (   $table)
abstract

Get a list of the available columns on the specified table. Used for autocomplete.

Parameters
string$tableName of the table
Returns
array List of column names
getDbName ( )
abstract

Get the name of the current database.

Returns
string Name of the database.
getDbType ( )
abstract

Get a description of the database/backend type.

Returns
string Name of the database system.
getDbVersion ( )
abstract

Get the version of the database/backend type.

Returns
string Version of the database system.
getTableNames ( )
abstract

Get a list of the available tables on the current database. Used for autocomplete.

Returns
array List of table names.
matchesMacro (   $s)
abstract

Checks whether the specified command is a supported or valid macro.

Parameters
string$sCommand
Returns
boolean true if yes or false if not
The documentation for this class was generated from the following file: