Docs For Class MDB2_Driver_Reverse

MDB2_Driver_Reverse_Common MDB2_Driver_Reverse_Common(

$db_index)

Parameters:

$db_index —

[ Top ]

MDB2_Driver_Reverse_Common __construct(

$db_index)

Constructor

Parameters:

$db_index —

[ Top ]

mixed getSequenceDefinition(
string
$sequence)

get the stucture of a sequence into an array

Return: data array on success, a MDB2 error on failure
Access: public

Parameters:

string $sequence — name of sequence that should be used in method

[ Top ]

mixed getTableFieldDefinition(
string
$table, 
$field, string
$fields)

get the stucture of a field into an array

Return: data array on success, a MDB2 error on failure
Access: public

Overridden in child classes as:

MDB2_Driver_Reverse_sqlite::getTableFieldDefinition(): get the stucture of a field into an array

MDB2_Driver_Reverse_mysqli::getTableFieldDefinition(): get the stucture of a field into an array

Parameters:

string	`$table`	—	name of table that should be used in method
string	`$fields`	—	name of field that should be used in method
	`$field`	—

[ Top ]

mixed getTableIndexDefinition(
string
$table, string
$index)

get the stucture of an index into an array

Return: data array on success, a MDB2 error on failure
Access: public

Overridden in child classes as:

MDB2_Driver_Reverse_sqlite::getTableIndexDefinition(): get the stucture of an index into an array

MDB2_Driver_Reverse_mysqli::getTableIndexDefinition(): get the stucture of an index into an array

Parameters:

string	`$table`	—	name of table that should be used in method
string	`$index`	—	name of index that should be used in method

[ Top ]

array tableInfo(
object|string
$result, [int
$mode = null])

Returns information about a table or a result set

The format of the resulting array depends on which $mode you select. The sample output below is based on this query:

    SELECT tblFoo.fldID, tblFoo.fldPhone, tblBar.fldId
    FROM tblFoo
    JOIN tblBar ON tblFoo.fldId = tblBar.fldId

null (default)

   [0] => Array (
       [table] => tblFoo
       [name] => fldId
       [type] => int
       [len] => 11
       [flags] => primary_key not_null
   )
   [1] => Array (
       [table] => tblFoo
       [name] => fldPhone
       [type] => string
       [len] => 20
       [flags] =>
   )
   [2] => Array (
       [table] => tblBar
       [name] => fldId
       [type] => int
       [len] => 11
       [flags] => primary_key not_null
   )

MDB2_TABLEINFO_ORDER In addition to the information found in the default output, a notation of the number of columns is provided by the num_fields element while the order element provides an array with the column names as the keys and their location index number (corresponding to the keys in the the default output) as the values. If a result set has identical field names, the last one is used.
```
 [num_fields] => 3
 [order] => Array (
 [fldId] => 2
 [fldTrans] => 1
 )
```
MDB2_TABLEINFO_ORDERTABLE Similar to MDB2_TABLEINFO_ORDER but adds more dimensions to the array in which the table names are keys and the field names are sub-keys. This is helpful for queries that join tables which have identical field names.
```
 [num_fields] => 3
 [ordertable] => Array (
 [tblFoo] => Array (
 [fldId] => 0
 [fldPhone] => 1
 )
 [tblBar] => Array (
 [fldId] => 2
 )
 )
```

The flags element contains a space separated list of extra information about the field. This data is inconsistent between DBMS's due to the way each DBMS works.

primary_key
unique_key
multiple_key
not_null

Most DBMS's only provide the table and flags elements if $result is a table name. The following DBMS's provide full information from queries:

fbsql
mysql

If the 'portability' option has MDB2_PORTABILITY_LOWERCASE turned on, the names of tables and fields will be lowercased.

Return: an associative array with the information requested. A MDB2_Error object on failure.
See: MDB2_common::setOption()

Overridden in child classes as:

MDB2_Driver_Reverse_ibase::tableInfo(): Returns information about a table or a result set

MDB2_Driver_Reverse_fbsql::tableInfo(): Returns information about a table or a result set

MDB2_Driver_Reverse_oci8::tableInfo(): Returns information about a table or a result set

MDB2_Driver_Reverse_sqlite::tableInfo(): Returns information about a table

MDB2_Driver_Reverse_mssql::tableInfo(): Returns information about a table or a result set

MDB2_Driver_Reverse_mysqli::tableInfo(): Returns information about a table or a result set

MDB2_Driver_Reverse_mysql::tableInfo(): Returns information about a table or a result set

Parameters:

object\|string	`$result`	—	MDB2_result object from a query or a string containing the name of a table. While this also accepts a query result resource identifier, this behavior is deprecated.
int	`$mode`	—	either unused or one of the tableInfo modes: `MDB2_TABLEINFO_ORDERTABLE`, `MDB2_TABLEINFO_ORDER` or `MDB2_TABLEINFO_FULL` (which does both). These are bitwise, so the first two can be combined using `\|`.

[ Top ]

Class: MDB2_Driver_Reverse_Common

Class Overview

Author(s):

Variables

Methods

Child classes:

Inherited Variables

Inherited Methods

Class Details

Class Variables

$db_index =

Method Detail

MDB2_Driver_Reverse_Common (Constructor) [line 84]

Parameters:

__construct (Constructor) [line 79]

Parameters:

getSequenceDefinition [line 135]

Parameters:

getTableFieldDefinition [line 100]

Parameters:

getTableIndexDefinition [line 118]

Parameters:

tableInfo [line 278]

Parameters: