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

Public Member Functions

 __construct ()
 
 connect ($conn_string)
 
 getDbName ()
 
 getDbType ()
 
 getDbVersion ()
 
 disconnect ()
 
 execute ($sql)
 
 getTableNames ()
 
 getColumnNames ($table)
 
 matchesMacro ($s)
 
- Public Member Functions inherited from DbBackendPlugin
 connect ($conn_string)
 
 disconnect ()
 
 execute ($sql)
 
 getDbName ()
 
 getDbType ()
 
 getDbVersion ()
 
 getTableNames ()
 
 getColumnNames ($table)
 
 matchesMacro ($s)
 

Detailed Description

Constructor & Destructor Documentation

__construct ( )

Constructor.

Definition at line 2188 of file matrixsqlclient.php.

Member Function Documentation

connect (   $conn_string)

Connects to the host/database.

Parameters
string$conn_stringSquiz Matrix system root.
Returns
boolean true on success, false on failure

Definition at line 2222 of file matrixsqlclient.php.

disconnect ( )

Disconnect from the database/host.

Returns
boolean true on success, false on failure

Definition at line 2290 of file matrixsqlclient.php.

execute (   $sql)

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

Definition at line 2302 of file matrixsqlclient.php.

getColumnNames (   $table)

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

Definition at line 2419 of file matrixsqlclient.php.

getDbName ( )

Get the name of the current database.

Returns
string Name of the database.

Definition at line 2254 of file matrixsqlclient.php.

getDbType ( )

Get a description of the database/backend type.

Returns
string Name of the database system.

Definition at line 2270 of file matrixsqlclient.php.

getDbVersion ( )

Get the version of the database/backend type.

Returns
string Version of the database system.

Definition at line 2280 of file matrixsqlclient.php.

getTableNames ( )

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

Returns
array List of table names.

Definition at line 2366 of file matrixsqlclient.php.

matchesMacro (   $s)

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

Parameters
string$sCommand
Returns
boolean true if yes or false if not

Definition at line 2468 of file matrixsqlclient.php.


The documentation for this class was generated from the following file: