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

Variables

Should this controller log add/edit/delete actions?

For a given field name, a type to use which is better than VARCHAR(200)

List of tools to show in the sidebar and index view

Functions

public __call (from BaseController)

Handles methods that do not exist.

public __construct

Constructor

public _run (from BaseController)

The router/kohana will invoke this method to invoke an action.

If you please, you may wrap this method to create before/after hooks.

public ajaxPageIds

Render page drop-down for given sub-site

public ajaxTableDefn

public api

Render API test form within DB tools

protected autoSetEmptyParam (from Controller)

Auto-set the "empty" param for fields with foreign keys to be NULL

This greatly reduces the number of foreign-key constraints hit in day-to-day use,
especially with file fields.

public bcryptSpeed

Benchmark the server to find appropriate cost parameter

protected deleteRecord (from Controller)

Deletes a record, and logs the deletion
This should be used by all _deleteSave methods
Starts a transaction and commits it if not already in a transaction when called

public email

Renders form to send emails

public emailSend

Process form submission

public exceptionDetail

Browse recent exceptions - details

public exceptionLog

Browse and search exceptions

public exportAction

Does the actual export

public exportFiles

UI to export all files

public exportFilesAction

Action to export all files

public exportTables

Export tables to an SQL file

public fileTypesIndexingSupport

Returns a list of file types which can be indexed for fulltext search

protected generateFormView (from Controller)

Generates a form view from a JSON config file

public generatePasswordHash

Generate a password hash to store in a config file
The username and hash are used by AdminAuth::processLocal

public getCssClassName (from BaseController)

Return the class name for this controller, expressed in CSS style, i.e. with dashes

Example: When called from BlogPostController --> 'blog-post-controller'

public getModulePath (from BaseController)

Gets the relative path to the module the controller lives in, or sprout itself

public gettempfile

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 importAction

Action for importing tables

public importFileAction

Action for importing files

public importFiles

Imports a files into the cms

public importOptions

public importSave

public importTables

Import database tables from a .sql file

public importXML

Renders form to imoprt Sprout2 Export XML

public importXmlAction

Process Sprout2 Export XML into this CMS

public index

Shows a list of database tools

public info

Output some sprout and platform info

protected jsonExtraValidate (from Controller)

Do any additional validation prior to saving the record

public launchChecks

Run a series of self-tests to ensure everything is configured correctly

public listRoutes

protected loadEditJson (from Controller)

Loads a JSON config file for an automated edit-type form for this controller

protected loadFormJson (from Controller)

Loads a config file for a JsonForm associated with this controller

protected loadRecord (from Controller)

Fetches the pre-update record from the database.
Used by the action log system, and disabled if the action log system has been turned off

protected logAction (from Controller)

Stores a history item in the database, recording an add (i.e. insert), edit, or delete.
Should be called AFTER the action has been made.
N.B. This is a low-level method; the friendlier wrapper methods are preferred;
e.g. Controller::logAdd, Controller::logEdit

protected logAdd (from Controller)

Logs an add action. This is a wrapper for Controller::logAction

protected logAddCategory (from Controller)

Logs the adding of a record to a category. This is a wrapper for Controller::logAction

protected logDelete (from Controller)

Logs a delete action. This is a wrapper for Controller::logAction

protected logDeleteCategory (from Controller)

Logs the removal of a record from a category. This is a wrapper for Controller::logAction

protected logEdit (from Controller)

Logs an edit action. This is a wrapper for Controller::logAction

public moduleBuilder

Generates blank modules

public moduleBuilderAction

public moduleBuilderDb

Generates db_struct.xml content for a module

public moduleBuilderExisting

Generates modules from an existing db_struct.xml file

public moduleBuilderExistingAction

Generates modules from an existing db_struct.xml file

public moduleBuilderExistingForm

Generates modules from an existing db_struct.xml file

public moduleBuilderExistingUploadAction

Generates modules from an existing db_struct.xml file

public mtTransform

Used by the module_template_action method

public multimake

Generate multiedit code

private outputSqlResultset

Renders SQL result set into a table

public qrCodeForm

Render form to set QR Code string

public qrCodeImage

Renders QR code image

protected replaceSet (from Controller)

Inserts records which are in $new_records, but are not in the specified table
Deletes records which are in the specified table, but not in $new_records
Updates records which are in both

Matching is done on the 'id' field, as a result the $new_records arrays MUST contain an id field.

protected saveJsonData (from Controller)

Automatically saves the data associated with a submission on a JSON-generated form

public sessionEditor

Edit the $_SESSION

public sessionEditorAction

Session Editor Action

private sessionLoop

List items in an array, along with the tools buttons

private sizeToHuman

Render table data size in human readable form

private splitSql

Splits a set of SQL queries into individual queries

public sql

Allows the user to execute SQL queries

public sqlcsv

public struct

Shows table and column definitions

public sync

Syncs the db structure to match db_struct.xml

private template

Render dbtools template

public testSkinTemplates

Simple tool for testing skin templates

public testSkinTemplatesAction

Actual viewing UI for templates

public varDump

Render view to see session and cookie data

private xmlGetColumns

private xmlGetTables

private xmlLoad