AdminCompanyPlugins extends AdminController
Admin Company Plugin Settings
Table of Contents
Methods
| available() | Plugins Available page |
| disable() | Disable a plugin |
| enable() | Enable a plugin |
| index() | Redirect to installed plugins |
| install() | Install a plugin |
| installed() | Plugins Installed page |
| manage() | Manage a plugin |
| preAction() | Pre-action |
| settings() | Manage settings for the plugin |
| uninstall() | Uninstall a plugin |
| upgrade() | Upgrades a plugin |
| performAction() | Performs an action on the given installed plugin |
| clearNavCache() | Clears the navigation cache for all staff in the system |
| formatSettingAction() | Formats the given plugin action by adding additional fields |
| getSettingActionBaseUri() | Determines the base URI of the given plugin action |
| processSettingsActions() | Processes any input submission data May sets any error messages to the current view, or redirect on successful submission |
| processSettingsAutomation() | Processes any input submission data May sets any error messages to the current view, or redirect on successful submission |
| processSettingsEvents() | Processes any input submission data May sets any error messages to the current view, or redirect on successful submission |
| renderSettingsActions() | Renders/Processes the automation settings for a plugin |
| renderSettingsAutomation() | Renders/Processes the automation settings for a plugin |
| renderSettingsEvents() | Renders/Processes the event settings for a plugin |
| renderSettingTab() | Processes and renders the given setting tab |
| setTabs() | Sets the available/installed tabs |
Methods
available()
Plugins Available page
public
available() : mixed
disable()
Disable a plugin
public
disable() : mixed
enable()
Enable a plugin
public
enable() : mixed
index()
Redirect to installed plugins
public
index() : mixed
install()
Install a plugin
public
install() : mixed
installed()
Plugins Installed page
public
installed() : mixed
manage()
Manage a plugin
public
manage() : mixed
preAction()
Pre-action
public
preAction() : mixed
settings()
Manage settings for the plugin
public
settings() : mixed
uninstall()
Uninstall a plugin
public
uninstall() : mixed
upgrade()
Upgrades a plugin
public
upgrade() : mixed
performAction()
Performs an action on the given installed plugin
protected
performAction(string $action, string $message) : mixed
Parameters
- $action : string
-
The PluginManager method to invoke
- $message : string
-
The success message to set on success
clearNavCache()
Clears the navigation cache for all staff in the system
private
clearNavCache() : mixed
formatSettingAction()
Formats the given plugin action by adding additional fields
private
formatSettingAction(stdClass $action) : stdClass
Parameters
- $action : stdClass
-
The plugin action to format
Return values
stdClass —The formatted plugin action
getSettingActionBaseUri()
Determines the base URI of the given plugin action
private
getSettingActionBaseUri(string $location[, string|null $parent_base_uri = null ][, string|null $base_uri = null ]) : string
Parameters
- $location : string
-
The action location
- $parent_base_uri : string|null = null
-
The parent action's base URI
- $base_uri : string|null = null
-
The value of the action's base URI
Return values
string —The plugin action base URI
processSettingsActions()
Processes any input submission data May sets any error messages to the current view, or redirect on successful submission
private
processSettingsActions(stdClass $plugin, array<string|int, mixed> $actions) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
- $actions : array<string|int, mixed>
-
An array of plugin actions
processSettingsAutomation()
Processes any input submission data May sets any error messages to the current view, or redirect on successful submission
private
processSettingsAutomation(stdClass $plugin, array<string|int, mixed> $tasks) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
- $tasks : array<string|int, mixed>
-
An array of automation tasks
processSettingsEvents()
Processes any input submission data May sets any error messages to the current view, or redirect on successful submission
private
processSettingsEvents(stdClass $plugin, array<string|int, mixed> $events) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
- $events : array<string|int, mixed>
-
An array of events
renderSettingsActions()
Renders/Processes the automation settings for a plugin
private
renderSettingsActions(stdClass $plugin) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
renderSettingsAutomation()
Renders/Processes the automation settings for a plugin
private
renderSettingsAutomation(stdClass $plugin) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
renderSettingsEvents()
Renders/Processes the event settings for a plugin
private
renderSettingsEvents(stdClass $plugin) : mixed
Parameters
- $plugin : stdClass
-
An stdClass object representing the plugin
renderSettingTab()
Processes and renders the given setting tab
private
renderSettingTab(string $name, stdClass $plugin) : mixed
Parameters
- $name : string
-
The name of the setting tab to process/render
- $plugin : stdClass
-
An stdClass object representing the plugin
Tags
setTabs()
Sets the available/installed tabs
private
setTabs() : mixed