Skip Navigation

UNL_UCBCN_Frontend API Documentation

Developers, developers, developers, devel…

Class UNL_UCBCN_Frontend_setup_postinstall

Description

This is the post install setup script for the frontend.

It takes in responses to questions and handles updating the default template as well as creating a sample index page.

Located in /UNL/UCBCN/Frontend_setup.php (line 29)


	
			
Variable Summary
mixed $createFiles
mixed $createIndex
mixed $dsn
Method Summary
mixed createFiles (array $answers)
void dircpy (string $source, string $dest, [bool $overwrite = false])
void file_str_replace (mixed $search, mixed $replace, mixed $file)
bool init (object &$config, object &$pkg, string $lastversion)
void outputData (string $msg)
prompts postProcessPrompts (array $prompts, string $section)
bool run (array $answers, string $phase)
Variables
mixed $createFiles (line 31)
  • access: public
mixed $createIndex (line 32)
  • access: public
mixed $dsn (line 33)
  • access: public
Methods
createFiles (line 112)

This function creates/upgrades the template files, as well as the sample index page.

  • access: public
mixed createFiles (array $answers)
  • array $answers: Associative array of answers from the user.
dircpy (line 187)

This function copies files from source to destination.

  • access: public
void dircpy (string $source, string $dest, [bool $overwrite = false])
  • string $source: Directory within the filesystem.
  • string $dest: Destination directory in the filesystem.
  • bool $overwrite: Should this overwrite existing files?
file_str_replace (line 148)

Replaces text within files.

  • access: public
void file_str_replace (mixed $search, mixed $replace, mixed $file)
  • mixed $search: An array or string of text to search for.
  • mixed $replace: An array or string of text to replace the matched text with.
  • mixed $file: An array or string of filenames to search and replace text in.
init (line 44)

Initialize the post-install task.

  • return: true
  • access: public
bool init (object &$config, object &$pkg, string $lastversion)
  • object &$config: PEAR_Config Pear configuration object.
  • object &$pkg: The object for the installed pear package.
  • string $lastversion: The previously installed version (if any).
outputData (line 224)

takes in a string and sends it to the client.

  • access: public
void outputData (string $msg)
  • string $msg: A string of text to send to the user.
postProcessPrompts (line 63)

Optionally used to alter responses from the prompted questions.

  • access: public
prompts postProcessPrompts (array $prompts, string $section)
  • array $prompts: Array of prompts.
  • string $section: The section currently being executed.
run (line 80)

Hub for the post-install task.

  • return: true | false
  • access: public
bool run (array $answers, string $phase)
  • array $answers: Associative array of answers from the user.
  • string $phase: The phase of the installation.

Documentation generated on Wed, 12 Aug 2009 13:00:47 -0500 by phpDocumentor 1.4.2