Class RSDEngine

Description

Rapid and Secure Development Engine - generates classes for accessing the database schema provided by the developer.

Located in /code/framework/RSDEngine/RSDEngine.php (line 254)


	
			
Variable Summary
Array $config
String $dir
Method Summary
RSDEngine RSDEngine (String $dir)
void copySkel (mixed $config)
void generate ([Mixed $config = false])
void loadConfig ()
void logInfo (String $msg)
void logWarn (String $msg)
void saveConfig ([mixed $config = false])
String _authorsToDocBook (String $authors)
void _copySkelDir (Array $config, String $from_path, String $to_path, [boolean $overwrite = true])
void _done ()
void _log (String $msg)
Variables
Array $config (line 267)

An associative array containing the configuration information. Each entry is represented by a key-value pair. The key is the name of the configuration option while the value is its value (!).

Gets set inside the method loadConfig.

String $dir (line 259)

The directory to which the geraration output should be saved. Gets set inside the constructor method.

int $_warnings = 0 (line 275)

The number of warnings that occurred.

Gets incremented by logWarn.

Methods
Constructor RSDEngine (line 284)

Construtor method.

Sets the property $dir

RSDEngine RSDEngine (String $dir)
  • String $dir: The directory to which the geraration output should be saved.
copySkel (line 478)
void copySkel (mixed $config)
generate (line 299)

Triggers the generation.

The result of the generation is saved in the directory $this->dir.

void generate ([Mixed $config = false])
  • Mixed $config: An associative array containing all configuration information needed for this generation. Note that if the boolean value false is passed, $this->config is used as configuration. Please see the Input - Configuration Options for help on the configuration options.
loadConfig (line 663)

Loads the configuration information of this version into the associative array $this->config.

The method performs the following operations to gain information about a project: It will read the file VERSION_ROOT/config.ini. It will try to read files named AUTHORS, README, RELEASE and INSTALL in that directory. It will try to read the file VERSION_ROOT/desing/ddl.sql. The returned array will contain fields for all agruments of the method EAF::createProject (exept $updateProject).

void loadConfig ()
logInfo (line 866)

Logs the info message passed as argument.

void logInfo (String $msg)
  • String $msg: The message to log.
logWarn (line 875)

Logs the warning message passed as argument.

void logWarn (String $msg)
  • String $msg: The message to log.
saveConfig (line 575)

Saves the configuration information for this version.

void saveConfig ([mixed $config = false])
_authorsToDocBook (line 897)

Returns a string containing DocBook Tags for the authors passed as argument.

  • return: A String containing DocBook tags for all authors.
String _authorsToDocBook (String $authors)
  • String $authors: A newline-sperated list of authors in the format 'Firstname Lastname <email@domain>'.
_copySkelDir (line 516)

Copies a directory including all subdirectories and files.

void _copySkelDir (Array $config, String $from_path, String $to_path, [boolean $overwrite = true])
  • Array $config: The configuration options stored in an associative arrray.
  • String $from_path: Source: the directory to copy. MUST end with a slash.
  • String $to_path: Destination: where the direcotry specified by the first argument should be copied to. MUST end with a slash.
  • boolean $overwrite: Whether to overwrite existing files.
_done (line 881)
void _done ()
_log (line 856)

Logs the message passed as argument.

  • access: private
void _log (String $msg)
  • String $msg: The message to log.

Documentation generated on Mon, 8 Dec 2003 13:10:43 +0100 by phpDocumentor 1.2.3