====== PluginController ======

**Layer:** ''Controller'' · **Source:** ''lib/controller/PluginController.php:26'' (lines 26–437)

----
<code>
class PluginController extends BaseApp
</code>

======= 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 | [[scriptlog:lib:core:baseapp|''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() ========

<code>
public function __construct(PluginService $pluginService)
</code>

//lines 44–47 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$pluginService'' |  [[scriptlog:lib:service:pluginservice|''PluginService'']] |  //required// |  //none// |


======== listItems() ========

<code>
public function listItems()
</code>

//lines 49–69 (21)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== retrievePluginSessionErrors() ========

<code>
private function retrievePluginSessionErrors()
</code>

//lines 71–80 (10)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== retrievePluginSessionStatus() ========

<code>
private function retrievePluginSessionStatus()
</code>

//lines 82–95 (14)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== insert() ========

<code>
public function insert()
</code>

//lines 97–100 (4)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== installPlugin() ========

<code>
public function installPlugin()
</code>

//lines 102–154 (53)//

//Takes no parameters.//

**Returns:** ''(none declared)''


======== validatePluginUpload() ========

<code>
private function validatePluginUpload($file_error, $file_size, $file_location, $file_name, &amp;$errors, $checkError)
</code>

//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() ========

<code>
private function handlePluginUploadError($file_error, &amp;$errors, $checkError)
</code>

//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() ========

<code>
private function saveInstalledPlugin($file_name)
</code>

//lines 232–253 (22)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$file_name'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== update() ========

<code>
public function update($id)
</code>

//lines 255–258 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== enablePlugin() ========

<code>
public function enablePlugin($id)
</code>

//lines 266–315 (50)//

enablePlugin

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== disablePlugin() ========

<code>
public function disablePlugin($id)
</code>

//lines 323–370 (48)//

disablePlugin

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== remove() ========

<code>
public function remove($id)
</code>

//lines 378–425 (48)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$id'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''


======== setView() ========

<code>
protected function setView($viewName)
</code>

//lines 433–436 (4)//

setView

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$viewName'' |  ''(untyped)'' |  //required// |  //none// |

**Returns:** ''(none declared)''

======= Imports =======

^ Alias ^ Fully-qualified name ^
| ''ActionConst'' | [[scriptlog:lib:core:actionconst|''Scriptlog\Core\ActionConst'']] |
| ''AppException'' | [[scriptlog:lib:core:appexception|''Scriptlog\Core\AppException'']] |
| ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] |
| ''LogError'' | [[scriptlog:lib:core:logerror|''Scriptlog\Core\LogError'']] |
| ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] |
| ''PluginService'' | [[scriptlog:lib:service:pluginservice|''Scriptlog\Service\PluginService'']] |


----

//This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//