Class CoughGeneratorFacade

Description

The CoughGeneratorFacade class provides a simple interface to the process of generating a schema from a database, manipulating it and converting FKs to relationships, and passing that info to the CoughGenerator which generates the classes.

CoughGeneratorFacade will provide at least an easy way to:

1) Given a config name, generate the files. 2) Given a config name, provide information about what would be generated (e.g. added, removed, and modified files).

Facade design pattern: "create a simplified interface of an existing interface to ease usage for common tasks"

  • author: Anthony Bush

Located in /cough_generator/CoughGeneratorFacade.class.php (line 20)


	
			
Variable Summary
boolean $verbose
Method Summary
void disableVerbose ()
void enableVerbose ()
void generate ( $configNameOrPath)
void generateFromConfigPath ( $configPath)
void getConfigPath ( $configNameOrPath)
void showStatus ( $configNameOrPath)
void showStatusFromConfigPath ( $configPath)
Variables
boolean $verbose = false (line 27)

Whether or not to echo what's happening to the screen.

  • access: protected
Methods
disableVerbose (line 45)

Disable verbose mode

void disableVerbose ()
enableVerbose (line 35)

Enable verbose mode

void enableVerbose ()
generate (line 49)
  • access: public
void generate ( $configNameOrPath)
  • $configNameOrPath
generateFromConfigPath (line 65)
  • access: protected
void generateFromConfigPath ( $configPath)
  • $configPath
getConfigPath (line 57)
  • access: protected
void getConfigPath ( $configNameOrPath)
  • $configNameOrPath
showStatus (line 53)
  • access: public
void showStatus ( $configNameOrPath)
  • $configNameOrPath
showStatusFromConfigPath (line 150)
  • access: protected
void showStatusFromConfigPath ( $configPath)
  • $configPath

Documentation generated on Wed, 12 Nov 2008 21:56:17 -0600 by phpDocumentor 1.4.0