Class: eDMySQLMS

Source Location: Program_Root/eDFramework/eDMySQLMS.php

Class Overview [line 15]

eDUtilities
   |
   --eDMySQLMS

MySQL Management System - DB Schema Builder

Author(s):

Version:

Copyright:

Variables

Methods


Inherited Methods

Class: eDUtilities

eDUtilities::introspection()
Dumps objects and arrays.
eDUtilities::is_defined()
Is the string $str_ defined From what I know, yet no PHP function allows to test if a string is defined.
eDUtilities::setTrace()
Sets the TRACE flag, mode and format
eDUtilities::trace()
Print a string and flushes the output buffer


Class Details

MySQL Management System - DB Schema Builder

This class purpose is to build a complete description of the databases, tables and fields of a MySQL server

Tags:

[ Top ]


Class Variables


Class Methods

eDMySQLMS

eDMySQLMS eDMySQLMS( [mixed $connId = null], mixed $aDB, mixed $aTable, [string $mode = 'extended'], [boolean $traceEnabled = FALSE])

[line 85]

Class Constructor

Change Log 31/12/2002 BPO SFBG#660339 eDFramework - eDMySQLMS Database Connect

Parameters:

  • string $mode - set execution mode to basic (contructor only), advanced (build the db schema) or extended (same as advanced)
  • boolean $traceEnabled - set trace mode (enables outputs) to TRUE or FALSE

[ Top ]

buildFieldsList

void buildFieldsList( string $atable, [mixed $getProperties = TRUE], string $adb)

[line 197]

Build the list of fields in table

Parameters:

  • string $adb - name of the db to process
  • string $atable - name of the table to process

[ Top ]

buildSchema

void buildSchema( )

[line 143]

Build Schema of dbs, tables and fields on local MySQL Server

Change Log 31/12/2002 BPO SFBG#660339 eDFramework - eDMySQLMS Database Connect

Parameters:

[ Top ]

buildTablesList

void buildTablesList( string $adb)

[line 176]

Build the list of tables in a db

Parameters:

  • string $adb - name of the db to process

[ Top ]

connect

void connect( [mixed $dbHost = 'localhost'], [mixed $dbUser = 'root'], [mixed $dbPassword = ''])

[line 121]

Connect the host database

Parameters:

[ Top ]

getDBTables

array getDBTables( )

[line 298]

Get array of kv pairs of databases and tables

Keys are databases names associated to arrays storing the list of tables in related database

Tags:

  • return - array of kv pairs of databases and tables

Parameters:

[ Top ]

getFieldsProperties

array getFieldsProperties( )

[line 313]

Get array of kv pairs of fields and their properties

Keys are fields names associated to arrays storing the list of their properties

Tags:

  • return - array of kv pairs of fields and their properties
  • since - eDFramework 2.1

Parameters:

[ Top ]

getTableFields

array getTableFields( )

[line 284]

Get array of kv pairs of tables and fields

Keys are tables names associated to arrays storing the list of fields in related table

Tags:

  • return - array of kv pairs of tables and fields

Parameters:

[ Top ]

search

array search( string $objectType, string $objectName)

[line 228]

Search the presence of field, table or db on the server

Tags:

  • return - array[0]<-db, array[1]<-table, array[2]<-field or null if not found

Parameters:

  • string $objectType - the type of the object to search, either 'database','table' or 'field'
  • string $objectName - the name of the object to find (a db, table or field name)

[ Top ]


Documentation generated on Wed, 10 Dec 2003 21:47:41 +0100 by phpDocumentor 1.2.2