Scriptlog Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== PluginService ======

**Layer:** ''Service'' &middot; **Source:** ''lib/service/PluginService.php:22'' (lines 22–294)

----
<code>
class PluginService
</code>

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

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$plugin_id'' |  | 29 |
| ''private'' | ''(untyped)'' | ''$name'' |  | 36 |
| ''private'' | ''(untyped)'' | ''$link'' |  | 43 |
| ''private'' | ''(untyped)'' | ''$directory'' |  | 51 |
| ''private'' | ''(untyped)'' | ''$description'' |  | 58 |
| ''private'' | ''(untyped)'' | ''$status'' |  | 65 |
| ''private'' | ''(untyped)'' | ''$level'' |  | 72 |
| ''private'' | ''(untyped)'' | ''$sort'' |  | 79 |
| ''private'' | ''(untyped)'' | ''$pluginDao'' |  | 87 |
| ''private'' | ''(untyped)'' | ''$validator'' |  | 95 |
| ''private'' | ''(untyped)'' | ''$sanitize'' |  | 97 |

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

<code>
public function __construct(PluginDao $pluginDao, FormValidator $validator, Sanitize $sanitize)
</code>

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

<code>
public function setPluginId($pluginId)
</code>

//lines 114–117 (4)//

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

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


======== setPluginName() ========

<code>
public function setPluginName($name)
</code>

//lines 119–122 (4)//

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

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


======== setPluginLink() ========

<code>
public function setPluginLink($link)
</code>

//lines 124–127 (4)//

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

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


======== setPluginDirectory() ========

<code>
public function setPluginDirectory($directory)
</code>

//lines 129–132 (4)//

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

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


======== setPluginDescription() ========

<code>
public function setPluginDescription($description)
</code>

//lines 134–137 (4)//

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

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


======== setPluginStatus() ========

<code>
public function setPluginStatus($status)
</code>

//lines 139–142 (4)//

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

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


======== setPluginLevel() ========

<code>
public function setPluginLevel($level)
</code>

//lines 144–147 (4)//

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

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


======== setPluginSort() ========

<code>
public function setPluginSort($sort)
</code>

//lines 149–152 (4)//

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

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


======== grabPlugins() ========

<code>
public function grabPlugins($orderBy = &#039;ID&#039;)
</code>

//lines 154–157 (4)//

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// |

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


======== grabPlugin() ========

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

//lines 159–162 (4)//

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

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


======== addPlugin() ========

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

//lines 164–181 (18)//

//Takes no parameters.//

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


======== modifyPlugin() ========

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

//lines 183–185 (3)//

//Takes no parameters.//

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


======== activateInstalledPlugin() ========

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

//lines 187–225 (39)//

//Takes no parameters.//

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


======== deactivateInstalledPlugin() ========

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

//lines 227–236 (10)//

//Takes no parameters.//

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


======== removePlugin() ========

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

//lines 238–260 (23)//

//Takes no parameters.//

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


======== isPluginExists() ========

<code>
public function isPluginExists($plugin_name)
</code>

//lines 267–270 (4)//

checking plugin exists or not

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

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


======== pluginLevelDropDown() ========

<code>
public function pluginLevelDropDown($selected = &quot;&quot;)
</code>

//lines 279–282 (4)//

Plugin level drop down

^  Parameter ^  Type ^  Default ^  Description ^
|  ''$selected'' |  ''(untyped)'' |  ''""'' |  //none// |

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


======== totalPlugins() ========

<code>
public function totalPlugins(array $data = []): ?int
</code>

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