Table of Contents
PluginController
Layer: Controller · Source: lib/controller/PluginController.php:26 (lines 26–437)
class PluginController extends BaseApp
Docblock Metadata
| Tag | Value |
|---|---|
@category | Class PluginController extends BaseApp |
@author | M.Noermoehammad |
@license | MIT |
@version | 1.0.0 |
@since | Since Release 1.0.0 |
Inheritance
| Relation | Type | Meaning |
|---|---|---|
| extends | ''BaseApp'' | parent class/interface |
Constants (0)
None.
Properties (2)
| Visibility | Type | Name | Default | Line |
|---|---|---|---|---|
private | (untyped) | $view | 34 | |
private | (untyped) | $pluginService | 42 |
Methods (14)
| Visibility | Method | Summary | Line |
|---|---|---|---|
| public | __construct() | (undocumented) | 44 |
| public | listItems() | (undocumented) | 49 |
| private | retrievePluginSessionErrors() | (undocumented) | 71 |
| private | retrievePluginSessionStatus() | (undocumented) | 82 |
| public | insert() | (undocumented) | 97 |
| public | installPlugin() | (undocumented) | 102 |
| private | validatePluginUpload() | (undocumented) | 156 |
| private | handlePluginUploadError() | (undocumented) | 210 |
| private | saveInstalledPlugin() | (undocumented) | 232 |
| public | update() | (undocumented) | 255 |
| public | enablePlugin() | enablePlugin | 266 |
| public | disablePlugin() | disablePlugin | 323 |
| public | remove() | remove | 378 |
| protected | setView() | setView | 433 |
__construct()
public function __construct(PluginService $pluginService)
lines 44–47 (4)
| Parameter | Type | Default | Description |
|---|---|---|---|
$pluginService | ''PluginService'' | required | none |
listItems()
public function listItems()
lines 49–69 (21)
Takes no parameters.
Returns: (none declared)
retrievePluginSessionErrors()
private function retrievePluginSessionErrors()
lines 71–80 (10)
Takes no parameters.
Returns: (none declared)
retrievePluginSessionStatus()
private function retrievePluginSessionStatus()
lines 82–95 (14)
Takes no parameters.
Returns: (none declared)
insert()
public function insert()
lines 97–100 (4)
Takes no parameters.
Returns: (none declared)
installPlugin()
public function installPlugin()
lines 102–154 (53)
Takes no parameters.
Returns: (none declared)
validatePluginUpload()
private function validatePluginUpload($file_error, $file_size, $file_location, $file_name, &$errors, $checkError)
lines 156–208 (53)
| Parameter | Type | Default | Description |
|---|---|---|---|
$file_error | (untyped) | required | none |
$file_size | (untyped) | required | none |
$file_location | (untyped) | required | none |
$file_name | (untyped) | required | none |
$errors (by reference) | (untyped) | required | none |
$checkError | (untyped) | required | none |
Returns: (none declared)
handlePluginUploadError()
private function handlePluginUploadError($file_error, &$errors, $checkError)
lines 210–230 (21)
| Parameter | Type | Default | Description |
|---|---|---|---|
$file_error | (untyped) | required | none |
$errors (by reference) | (untyped) | required | none |
$checkError | (untyped) | required | none |
Returns: (none declared)
saveInstalledPlugin()
private function saveInstalledPlugin($file_name)
lines 232–253 (22)
| Parameter | Type | Default | Description |
|---|---|---|---|
$file_name | (untyped) | required | none |
Returns: (none declared)
update()
public function update($id)
lines 255–258 (4)
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
Returns: (none declared)
enablePlugin()
public function enablePlugin($id)
lines 266–315 (50)
enablePlugin
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
Returns: (none declared)
disablePlugin()
public function disablePlugin($id)
lines 323–370 (48)
disablePlugin
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
Returns: (none declared)
remove()
public function remove($id)
lines 378–425 (48)
| Parameter | Type | Default | Description |
|---|---|---|---|
$id | (untyped) | required | none |
Returns: (none declared)
setView()
protected function setView($viewName)
lines 433–436 (4)
setView
| Parameter | Type | Default | Description |
|---|---|---|---|
$viewName | (untyped) | required | none |
Returns: (none declared)
Imports
| Alias | Fully-qualified name |
|---|---|
ActionConst | ''Scriptlog\Core\ActionConst'' |
AppException | ''Scriptlog\Core\AppException'' |
BaseApp | ''Scriptlog\Core\BaseApp'' |
LogError | ''Scriptlog\Core\LogError'' |
View | ''Scriptlog\Core\View'' |
PluginService | ''Scriptlog\Service\PluginService'' |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.