\OnePunch
Allows you to be an Saitama!
Synopsis
class OnePunch
{
- // constants
- const URL_DEVCON = '?module=sqlconsole&devconsole=true';
- const TABLE_DATASOURCE = 'punchscripts';
- // members
- protected array $punchScripts = ;
- protected $messages = '';
- protected string $defaultSortField = '';
- protected $ubConfig = '';
- protected $punchDb = '';
- // methods
- public void __construct()
- protected void initMessages()
- protected void initDatabase()
- protected void loadOptions()
- protected void loadScripts()
- public array getAllScripts()
- protected bool checkAlias()
- public string renderCreateForm()
- public string renderEditForm()
- public void/string createScript()
- public void/string deleteScript()
- public void saveScript()
- public void importOldTemplates()
- public string renderScriptsList()
- public string getScriptContent()
- public bool isAliasFree()
- public void/string installScript()
Constants
Name | Value |
---|---|
URL_DEVCON | '?module=sqlconsole&devconsole=true' |
TABLE_DATASOURCE | 'punchscripts' |
Members
protected
- $defaultSortField
—
string
Placeholder for ONEPUNCH_DEFAULT_SORT_FIELD - $messages
—
System message helper object placeholder - $punchDb
—
Punch scripts database abstraction layer placeholder - $punchScripts
—
array
Contains available punch scripts as alias=>data - $ubConfig
—
System config object placeholder
Methods
protected
- checkAlias() — Checks is some script alias unused?
- initDatabase() — Inits database abstraction layer
- initMessages() — Inits system message helper object instance for further usage
- loadOptions() — Load required configs and sets some properties depends by options
- loadScripts() — Loads existing punch scripts from database
public
- __construct() — Creates new object instance
- createScript() — Creates new script in database
- deleteScript() — Deletes some script from database by his alias
- getAllScripts() — Returns array of loaded scripts as alias=>scriptData
- getScriptContent() — Returns executable content of existing punch script
- importOldTemplates() — Performs old dev console code templates migration into one-punch scripts
- installScript() — Installs some third-party script
- isAliasFree() — Checks is some script alias exists?
- renderCreateForm() — Renders new script creation form
- renderEditForm() — Renders script editing form
- renderScriptsList() — Renders list of available punch scripts with some controls
- saveScript() — Saves script data into database