SproutCMS

This is the code documentation for the SproutCMS project

class WelcomeController

Forms used for setting up SproutCMS for the first time

Extending this class

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