====== PluginDao ====== **Layer:** ''DAO'' · **Source:** ''lib/dao/PluginDao.php:21'' (lines 21–353) ---- class PluginDao extends Dao Plugin class extends Plugin ======= Docblock Metadata ======= ^ Tag ^ Value ^ | ''@category'' | Dao Class | | ''@author'' | M.Noermoehammad | | ''@license'' | MIT | | ''@version'' | 1.0 | | ''@since'' | Since Release 1.0 | ======= Inheritance ======= ^ Relation ^ Type ^ Meaning ^ | extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface | ======= Constants (0) ======= //None.// ======= Properties (2) ======= ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ | ''private'' | ''(untyped)'' | ''$accessLevel'' | | 23 | | ''private'' | ''(untyped)'' | ''$selected'' | | 25 | ======= Methods (16) ======= ^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | (undocumented) | 27 | | public | ''getPlugins()'' | Get list of plugins | 41 | | public | ''getPlugin()'' | Get plugin | 64 | | public | ''insertPlugin()'' | Insert new plugin | 85 | | public | ''updatePlugin()'' | Update plugin | 122 | | public | ''activatePlugin()'' | activatePlugin | 144 | | public | ''deactivatePlugin()'' | deactivatePlugin | 157 | | public | ''deletePlugin()'' | Delete plugin | 169 | | public | ''checkPluginId()'' | Check plugin Id | 183 | | public | ''isPluginActived()'' | isPluginActived | 206 | | public | ''getPluginDirectory()'' | getPluginDirectory | 230 | | public | ''setMenuPlugin()'' | Set menu plugin | 245 | | public | ''dropDownPluginLevel()'' | Drop down plugin level | 289 | | public | ''totalPluginRecords()'' | Total plugins records | 309 | | public | ''findPluginsEnabled()'' | SetPlugins | 322 | | public | ''pluginExists()'' | pluginExists | 345 | ======== __construct() ======== public function __construct() //lines 27–30 (4)// //Takes no parameters.// ======== getPlugins() ======== public function getPlugins($orderBy = 'ID') //lines 41–53 (13)// Get list of plugins ^ Parameter ^ Type ^ Default ^ Description ^ | ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// | **Returns:** ''(none declared)'' — boolean|array|object ======== getPlugin() ======== public function getPlugin($id, $sanitize) //lines 64–77 (14)// Get plugin get single value of plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — boolean|array|object ======== insertPlugin() ======== public function insertPlugin($bind) //lines 85–113 (29)// Insert new plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$bind'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' ======== updatePlugin() ======== public function updatePlugin($sanitize, $bind, $id) //lines 122–135 (14)// Update plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | ''$bind'' | ''(untyped)'' | //required// | //none// | | ''$id'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' ======== activatePlugin() ======== public function activatePlugin($id, $sanitize) //lines 144–148 (5)// activatePlugin Enable plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' ======== deactivatePlugin() ======== public function deactivatePlugin($id, $sanitize) //lines 157–161 (5)// deactivatePlugin Disable plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' ======== deletePlugin() ======== public function deletePlugin($id, $sanitize) //lines 169–173 (5)// Delete plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' ======== checkPluginId() ======== public function checkPluginId($id, $sanitize) //lines 183–195 (13)// Check plugin Id ^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — numeric ======== isPluginActived() ======== public function isPluginActived($plugin_name) //lines 206–219 (14)// isPluginActived checking whether plugin enabled or disabled ^ Parameter ^ Type ^ Default ^ Description ^ | ''$plugin_name'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — boolean ======== getPluginDirectory() ======== public function getPluginDirectory($plugin_name) //lines 230–236 (7)// getPluginDirectory get plugin directory by name ^ Parameter ^ Type ^ Default ^ Description ^ | ''$plugin_name'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — string|bool ======== setMenuPlugin() ======== public function setMenuPlugin($module, $user_level) //lines 245–280 (36)// Set menu plugin ^ Parameter ^ Type ^ Default ^ Description ^ | ''$module'' | ''(untyped)'' | //required// | //none// | | ''$user_level'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — string ======== dropDownPluginLevel() ======== public function dropDownPluginLevel($selected = '') //lines 289–300 (12)// Drop down plugin level ^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | '''''' | //none// | **Returns:** ''(none declared)'' — string ======== totalPluginRecords() ======== public function totalPluginRecords(array $data = []): ?int //lines 309–314 (6)// Total plugins records ^ Parameter ^ Type ^ Default ^ Description ^ | ''$data'' | ''array'' | ''[]'' | //none// | **Returns:** ''?int'' — numeric ======== findPluginsEnabled() ======== public function findPluginsEnabled($plugin_level) //lines 322–335 (14)// SetPlugins ^ Parameter ^ Type ^ Default ^ Description ^ | ''$plugin_level'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — boolean|array|object ======== pluginExists() ======== public function pluginExists($plugin_name) //lines 345–352 (8)// pluginExists checking whether plugin names exists ^ Parameter ^ Type ^ Default ^ Description ^ | ''$plugin_name'' | ''(untyped)'' | //required// | //none// | **Returns:** ''(none declared)'' — boolean ======= Imports ======= ^ Alias ^ Fully-qualified name ^ | ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] | ---- //This page is generated from source by 'tools/gendoc'. Edits will be overwritten.//