WelcomeController class - Documentation for SproutCMS

Info Page:

Page options:

class WelcomeController

Forms used for setting up SproutCMS for the first time

File: /modules/Welcome/Controllers/WelcomeController.php
Namespace: SproutModules\Karmabunny\Welcome\Controllers
Extends: Controller

Functions

Name	Visibility	Description
__construct	public
addSampleAction	public	Add sample content
addSampleFiles	private	Add sample files from sample_content/files.xml
addSampleHomePage	private	Updates to home page - hardcoded rather than an xml file
addSamplePages	private	Add sample files from sample_content/pages.xml
checklist	public	Display the welcome checklist
dbConfDatabase	public (static)	Generate and download a database config file
dbConfForm	public	Show a UI for generating a database config
dbConfHosts	public (static)	Generate and download a dev hosts config file
dbConfPassword	public (static)	Generate and download a password config file
dbConfResult	public	Display the generated database config
dbConfTest	public	Ajax method to test the db connection for a given set of params
genDbConfig	private (static)	Generate a database config from given parameters
genDevHostsConfig	private (static)	Generate a dev hosts config, which contains the existing config and the current hostname
genPassConfig	private (static)	Generate a database password file from given parameters
passwordComplexity	private (static)	Ensure password has enough complexity
phpInfo	public	Show a phpinfo() view along with some extra information
redirect	public	Redirect home page traffic to the welcome checklist
superOperatorAction	public	Create a super operator
superOperatorConf	public	Generate and download super operator config file
superOperatorForm	public	Show a UI to create a super-operator
superOperatorResult	public	Show the generated super operator details
sync	public	Run a database sync
testDbconf	private	Test the database config is correct
testDbsync	private	Test that tables are available
testSampleContent	private	Test that sample content has been added
testSuperOp	private	Test whether one or more super operators have been created
testWelcome	private	Test that the welcome module isn't installed
wipeTables	private	Wipe the tables used by the sample code system (dev only code)

public __construct

void $WelcomeController->__construct ( );

This function does not have a description

public addSampleAction

void $WelcomeController->addSampleAction ( );

Add sample content

private addSampleFiles

void $WelcomeController->addSampleFiles ( );

Add sample files from sample_content/files.xml

private addSampleHomePage

void $WelcomeController->addSampleHomePage ( );

Updates to home page - hardcoded rather than an xml file

private addSamplePages

void $WelcomeController->addSamplePages ( );

Add sample files from sample_content/pages.xml

public checklist

void $WelcomeController->checklist ( );

Display the welcome checklist

public dbConfDatabase

void WelcomeController::dbConfDatabase ( );

Generate and download a database config file

public dbConfForm

void $WelcomeController->dbConfForm ( );

Show a UI for generating a database config

public dbConfHosts

void WelcomeController::dbConfHosts ( );

Generate and download a dev hosts config file

public dbConfPassword

void WelcomeController::dbConfPassword ( );

Generate and download a password config file

public dbConfResult

void $WelcomeController->dbConfResult ( );

Display the generated database config

public dbConfTest

void $WelcomeController->dbConfTest ( );

Ajax method to test the db connection for a given set of params

private genDbConfig

string WelcomeController::genDbConfig ( array $data );

Generate a database config from given parameters

private genDevHostsConfig

string WelcomeController::genDevHostsConfig ( );

Generate a dev hosts config, which contains the existing config and the current hostname

private genPassConfig

string WelcomeController::genPassConfig ( array $data );

Generate a database password file from given parameters

private passwordComplexity

unknown WelcomeController::passwordComplexity ( mixed $str );

Ensure password has enough complexity

public phpInfo

void $WelcomeController->phpInfo ( );

Show a phpinfo() view along with some extra information

public redirect

void $WelcomeController->redirect ( );

Redirect home page traffic to the welcome checklist

public superOperatorAction

void $WelcomeController->superOperatorAction ( );

Create a super operator

public superOperatorConf

void $WelcomeController->superOperatorConf ( );

Generate and download super operator config file

public superOperatorForm

void $WelcomeController->superOperatorForm ( );

Show a UI to create a super-operator

public superOperatorResult

void $WelcomeController->superOperatorResult ( );

Show the generated super operator details

public sync

void $WelcomeController->sync ( );

Run a database sync

private testDbconf

array $WelcomeController->testDbconf ( );

Test the database config is correct

private testDbsync

array $WelcomeController->testDbsync ( );

Test that tables are available

private testSampleContent

array $WelcomeController->testSampleContent ( );

Test that sample content has been added

private testSuperOp

array $WelcomeController->testSuperOp ( );

Test whether one or more super operators have been created

private testWelcome

array $WelcomeController->testWelcome ( );

Test that the welcome module isn't installed

private wipeTables

void $WelcomeController->wipeTables ( );

Wipe the tables used by the sample code system (dev only code)

SproutCMS

Search documentation