This is an old revision of the document!
Table of Contents
PluginService
Layer: Service · Source: lib/service/PluginService.php:22 (lines 22–294)
class PluginService
Docblock Metadata
^ Tag ^ Value ^ | ''@category'' | Service class | | ''@author'' | M.Noermoehammad | | ''@license'' | MIT | | ''@version'' | 1.0 | | ''@since'' | Since Release 1.0 |
Inheritance
No parent, interface or trait. This is a root type.
Constants (0)
None.
Properties (0)
None declared.
Methods (19)
^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | Constructor | 107 | | public | ''setPluginId()'' | (undocumented) | 114 | | public | ''setPluginName()'' | (undocumented) | 119 | | public | ''setPluginLink()'' | (undocumented) | 124 | | public | ''setPluginDirectory()'' | (undocumented) | 129 | | public | ''setPluginDescription()'' | (undocumented) | 134 | | public | ''setPluginStatus()'' | (undocumented) | 139 | | public | ''setPluginLevel()'' | (undocumented) | 144 | | public | ''setPluginSort()'' | (undocumented) | 149 | | public | ''grabPlugins()'' | (undocumented) | 154 | | public | ''grabPlugin()'' | (undocumented) | 159 | | public | ''addPlugin()'' | (undocumented) | 164 | | public | ''modifyPlugin()'' | (undocumented) | 183 | | public | ''activateInstalledPlugin()'' | (undocumented) | 187 | | public | ''deactivateInstalledPlugin()'' | (undocumented) | 227 | | public | ''removePlugin()'' | (undocumented) | 238 | | public | ''isPluginExists()'' | checking plugin exists or not | 267 | | public | ''pluginLevelDropDown()'' | Plugin level drop down | 279 | | public | ''totalPlugins()'' | Total plugin records | 290 |
__construct()
public function __construct(PluginDao $pluginDao, FormValidator $validator, Sanitize $sanitize)
lines 107–112 (6)
Constructor
^ Parameter ^ Type ^ Default ^ Description ^ | ''$pluginDao'' | [[scriptlog:lib:dao:plugindao|''PluginDao'']] | //required// | //none// | | ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// | | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// |
setPluginId()
public function setPluginId($pluginId)
lines 114–117 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$pluginId'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginName()
public function setPluginName($name)
lines 119–122 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$name'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginLink()
public function setPluginLink($link)
lines 124–127 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$link'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginDirectory()
public function setPluginDirectory($directory)
lines 129–132 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$directory'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginDescription()
public function setPluginDescription($description)
lines 134–137 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$description'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginStatus()
public function setPluginStatus($status)
lines 139–142 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$status'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginLevel()
public function setPluginLevel($level)
lines 144–147 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$level'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setPluginSort()
public function setPluginSort($sort)
lines 149–152 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$sort'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
grabPlugins()
public function grabPlugins($orderBy = 'ID')
lines 154–157 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// |
Returns: (none declared)
grabPlugin()
public function grabPlugin($id)
lines 159–162 (4)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
addPlugin()
public function addPlugin()
lines 164–181 (18)
Takes no parameters.
Returns: (none declared)
modifyPlugin()
public function modifyPlugin()
lines 183–185 (3)
Takes no parameters.
Returns: (none declared)
activateInstalledPlugin()
public function activateInstalledPlugin()
lines 187–225 (39)
Takes no parameters.
Returns: (none declared)
deactivateInstalledPlugin()
public function deactivateInstalledPlugin()
lines 227–236 (10)
Takes no parameters.
Returns: (none declared)
removePlugin()
public function removePlugin()
lines 238–260 (23)
Takes no parameters.
Returns: (none declared)
isPluginExists()
public function isPluginExists($plugin_name)
lines 267–270 (4)
checking plugin exists or not
^ Parameter ^ Type ^ Default ^ Description ^ | ''$plugin_name'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
pluginLevelDropDown()
public function pluginLevelDropDown($selected = "")
lines 279–282 (4)
Plugin level drop down
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | ''""'' | //none// |
Returns: (none declared) — string
totalPlugins()
public function totalPlugins(array $data = []): ?int
lines 290–293 (4)
Total plugin records
^ Parameter ^ Type ^ Default ^ Description ^ | ''$data'' | ''array'' | ''[]'' | //none// |
Returns: ?int — integer
Imports
^ Alias ^ Fully-qualified name ^ | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | ''PluginDao'' | [[scriptlog:lib:dao:plugindao|''Scriptlog\Dao\PluginDao'']] |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.
