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

class PluginController extends BaseApp

^ Tag ^ Value ^
| ''@category'' | Class PluginController extends BaseApp |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0.0 |
| ''@since'' | Since Release 1.0.0 |

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface |

None.

None declared.

^ 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 |

public function __construct(PluginService $pluginService)

lines 44–47 (4)

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

public function listItems()

lines 49–69 (21)

Takes no parameters.

Returns: (none declared)

private function retrievePluginSessionErrors()

lines 71–80 (10)

Takes no parameters.

Returns: (none declared)

private function retrievePluginSessionStatus()

lines 82–95 (14)

Takes no parameters.

Returns: (none declared)

public function insert()

lines 97–100 (4)

Takes no parameters.

Returns: (none declared)

public function installPlugin()

lines 102–154 (53)

Takes no parameters.

Returns: (none declared)

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)

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)

private function saveInstalledPlugin($file_name)

lines 232–253 (22)

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

Returns: (none declared)

public function update($id)

lines 255–258 (4)

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

Returns: (none declared)

public function enablePlugin($id)

lines 266–315 (50)

enablePlugin

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

Returns: (none declared)

public function disablePlugin($id)

lines 323–370 (48)

disablePlugin

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

Returns: (none declared)

public function remove($id)

lines 378–425 (48)

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

Returns: (none declared)

protected function setView($viewName)

lines 433–436 (4)

setView

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

Returns: (none declared)

^ 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.