SproutCMS

class DbToolsController

Provides tools for dealing with the database
Tools include a sync tool and a structure viewer

• File: /sprout/Controllers/DbToolsController.php
• Namespace: Sprout\Controllers
• Extends: Controller

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-15
**/
class NewClassName extends DbToolsController {
    
    /**
    * Renders QR code image
    **/
    public function qrCodeImage () {
        // Method code goes here
    }
    
    /**
    * Render page drop-down for given sub-site
    **/
    public function ajaxPageIds (int $subsite_id) {
        // Method code goes here
    }
    
    /**
    * Process form submission
    **/
    public function emailSend () {
        // Method code goes here
    }
    
    /**
    * Render form to set QR Code string
    **/
    public function qrCodeForm () {
        // Method code goes here
    }
    
    /**
    * Render API test form within DB tools
    **/
    public function api (string $class, string $method) {
        // Method code goes here
    }
    
    /**
    * Process Sprout2 Export XML into this CMS
    **/
    public function importXmlAction () {
        // Method code goes here
    }
    
    /**
    * Renders form to imoprt Sprout2 Export XML
    **/
    public function importXML () {
        // Method code goes here
    }
    
    /**
    * Renders form to send emails
    **/
    public function email () {
        // Method code goes here
    }
    
    private function xmlLoad ($module) {
        // Method code goes here
    }
    
    private function xmlGetColumns (DOMDocument $doc, $table_name) {
        // Method code goes here
    }
    
    /**
    * Simple tool for testing skin templates
    **/
    public function testSkinTemplates () {
        // Method code goes here
    }
    
    /**
    * Actual viewing UI for templates
    **/
    public function testSkinTemplatesAction (string $skin, string $tmpl) {
        // Method code goes here
    }
    
    /**
    * Generate multiedit code
    **/
    public function multimake () {
        // Method code goes here
    }
    
    private function xmlGetTables (DOMDocument $doc) {
        // Method code goes here
    }
    
    /**
    * Generates modules from an existing db_struct.xml file
    **/
    public function moduleBuilderExistingAction ($input_xml) {
        // Method code goes here
    }
    
    /**
    * Used by the module_template_action method
    **/
    public function mtTransform ($text) {
        // Method code goes here
    }
    
    /**
    * Browse and search exceptions
    **/
    public function exceptionLog () {
        // Method code goes here
    }
    
    /**
    * Browse recent exceptions - details
    **/
    public function exceptionDetail () {
        // Method code goes here
    }
    
    /**
    * Generate a password hash to store in a config file
    * The username and hash are used by {@see AdminAuth::processLocal}
    **/
    public function generatePasswordHash () {
        // Method code goes here
    }
    
    /**
    * Render view to see session and cookie data
    **/
    public function varDump () {
        // Method code goes here
    }
    
    /**
    * Generates modules from an existing db_struct.xml file
    **/
    public function moduleBuilderExistingForm ($input_xml) {
        // Method code goes here
    }
    
    /**
    * Action to export all files
    **/
    public function exportFilesAction () {
        // Method code goes here
    }
    
    /**
    * Edit the $_SESSION
    **/
    public function sessionEditor () {
        // Method code goes here
    }
    
    /**
    * List items in an array, along with the tools buttons
    **/
    private function sessionLoop ($a, $depth, $keys) {
        // Method code goes here
    }
    
    /**
    * Session Editor Action
    **/
    public function sessionEditorAction () {
        // Method code goes here
    }
    
    public function listRoutes () {
        // Method code goes here
    }
    
    /**
    * Generates blank modules
    **/
    public function moduleBuilder () {
        // Method code goes here
    }
    
    public function moduleBuilderAction () {
        // Method code goes here
    }
    
    /**
    * Generates db_struct.xml content for a module
    **/
    public function moduleBuilderDb () {
        // Method code goes here
    }
    
    /**
    * Generates modules from an existing db_struct.xml file
    **/
    public function moduleBuilderExisting () {
        // Method code goes here
    }
    
    /**
    * Generates modules from an existing db_struct.xml file
    **/
    public function moduleBuilderExistingUploadAction () {
        // Method code goes here
    }
    
    /**
    * UI to export all files
    **/
    public function exportFiles () {
        // Method code goes here
    }
    
    /**
    * Returns a list of file types which can be indexed for fulltext search
    **/
    public function fileTypesIndexingSupport () {
        // Method code goes here
    }
    
    /**
    * Export tables to an SQL file
    **/
    public function exportTables () {
        // Method code goes here
    }
    
    /**
    * Run a series of self-tests to ensure everything is configured correctly
    **/
    public function launchChecks () {
        // Method code goes here
    }
    
    /**
    * Allows files to be downloaded from the temporary directory
    * 
    * Only certain files from the temp directory can be downloaded.
    * Each 'source' has a regex which is used to restrict downloads to only that particular type of file
    **/
    public function gettempfile (string $source, string $tempfile, string $orig) {
        // Method code goes here
    }
    
    /**
    * Action for importing files
    **/
    public function importFileAction () {
        // Method code goes here
    }
    
    /**
    * Imports a files into the cms
    **/
    public function importFiles () {
        // Method code goes here
    }
    
    /**
    * Does the actual export
    **/
    public function exportAction () {
        // Method code goes here
    }
    
    /**
    * Render table data size in human readable form
    **/
    private function sizeToHuman (int $size) {
        // Method code goes here
    }
    
    public function importOptions () {
        // Method code goes here
    }
    
    /**
    * Action for importing tables
    **/
    public function importAction () {
        // Method code goes here
    }
    
    /**
    * Import database tables from a .sql file
    **/
    public function importTables () {
        // Method code goes here
    }
    
    public function importSave () {
        // Method code goes here
    }
    
    public function ajaxTableDefn ($table) {
        // Method code goes here
    }
    
    /**
    * Syncs the db structure to match db_struct.xml
    **/
    public function sync () {
        // Method code goes here
    }
    
    /**
    * Shows table and column definitions
    **/
    public function struct ($arg) {
        // Method code goes here
    }
    
    /**
    * Renders SQL result set into a table
    **/
    private function outputSqlResultset (PDOStatement $results, mixed $headings) {
        // Method code goes here
    }
    
    public function sqlcsv () {
        // Method code goes here
    }
    
    /**
    * Allows the user to execute SQL queries
    **/
    public function sql () {
        // Method code goes here
    }
    
    /**
    * Splits a set of SQL queries into individual queries
    **/
    private function splitSql ($all) {
        // Method code goes here
    }
    
    /**
    * Shows a list of database tools
    **/
    public function index () {
        // Method code goes here
    }
    
    /**
    * Output some sprout and platform info
    **/
    public function info () {
        // Method code goes here
    }
    
    /**
    * Benchmark the server to find appropriate cost parameter
    **/
    public function bcryptSpeed () {
        // Method code goes here
    }
    
    /**
    * Constructor
    **/
    public function __construct () {
        // Method code goes here
    }
    
    /**
    * Render dbtools template
    **/
    private function template (string $main_title, $html) {
        // Method code goes here
    }
    
}
?>