MDB2
[ class tree: MDB2 ] [ index: MDB2 ] [ all elements ]

Class: MDB2_Driver_Reverse_Common

Source Location: /MDB2-2.0.0beta2/MDB2/Driver/Reverse/Common.php

Class Overview


Base class for the schema reverse engineering module that is extended by each MDB2 driver


Author(s):

Variables

Methods


Child classes:

MDB2_Driver_Reverse_ibase
MDB2 InterbaseBase driver for the reverse engineering module
MDB2_Driver_Reverse_mysql
MDB2 MySQL driver for the schema reverse engineering module
MDB2_Driver_Reverse_fbsql
MDB2 FrontBase driver for the schema reverse engineering module
MDB2_Driver_Reverse_oci8
MDB2 Oracle driver for the schema reverse engineering module
MDB2_Driver_Reverse_sqlite
MDB2 SQlite driver for the schema reverse engineering module
MDB2_Driver_Reverse_mssql
MDB2 MSSQL driver for the schema reverse engineering module

Inherited Variables

Inherited Methods


Class Details

[line 70]
Base class for the schema reverse engineering module that is extended by each MDB2 driver


[ Top ]


Class Variables

$db_index =

[line 72]


Type:   mixed


[ Top ]



Method Detail

MDB2_Driver_Reverse_Common (Constructor)   [line 80]

MDB2_Driver_Reverse_Common MDB2_Driver_Reverse_Common( $db_index)

Constructor

Parameters:

   $db_index   — 

[ Top ]

getSequenceDefinition   [line 131]

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 ]

getTableFieldDefinition   [line 96]

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_mysql::getTableFieldDefinition()
get the stucture of a field into an array
MDB2_Driver_Reverse_sqlite::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 ]

getTableIndexDefinition   [line 114]

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_mysql::getTableIndexDefinition()
get the stucture of an index into an array
MDB2_Driver_Reverse_sqlite::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 ]

tableInfo   [line 275]

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 <p>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.</p> <p>If a result set has identical field names, the last one is used.</p>
       [num_fields] => 3
       [order] => Array (
           [fldId] => 2
           [fldTrans] => 1
       )
  • MDB2_TABLEINFO_ORDERTABLE <p>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.</p>
       [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. If something goes wrong an error object is returned.
  • See: MDB2_Driver_Common::setOption()
  • Access: public

Overridden in child classes as:

MDB2_Driver_Reverse_ibase::tableInfo()
Returns information about a table or a result set.
MDB2_Driver_Reverse_mysql::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_mssql::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 ]


Documentation generated on Mon, 11 Mar 2019 10:15:44 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.