| Next revision | Previous revision |
| scriptlog:lib:dao:menudao [2026/09/26 09:09] – admin admin | scriptlog:lib:dao:menudao [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Docblock Metadata ======= | ======= Docblock Metadata ======= |
| |
| ^ Tag ^ Value ^ | ^ Tag ^ Value ^ |
| | ''@category'' | Dao Class | | | ''@category'' | Dao Class | |
| | ''@author'' | M.Noermoehammad | | | ''@author'' | M.Noermoehammad | |
| | ''@license'' | MIT | | | ''@license'' | MIT | |
| | ''@version'' | 1.0 | | | ''@version'' | 1.0 | |
| | ''@since'' | Since Release 1.0 | | | ''@since'' | Since Release 1.0 | |
| |
| ======= Inheritance ======= | ======= Inheritance ======= |
| |
| ^ Relation ^ Type ^ Meaning ^ | ^ Relation ^ Type ^ Meaning ^ |
| | extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface | | | extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface | |
| |
| ======= Constants (0) ======= | ======= Constants (0) ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (1) ======= |
| |
| //None declared.// | ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ |
| | | ''private'' | ''(untyped)'' | ''$selected'' | | 23 | |
| |
| ======= Methods (16) ======= | ======= Methods (16) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public | ''__construct()'' | (undocumented) | 28 | | | public | ''__construct()'' | (undocumented) | 28 | |
| | public | ''findMenus()'' | Find all menus | 40 | | | public | ''findMenus()'' | Find all menus | 40 | |
| | public | ''findMenu()'' | findMenu | 61 | | | public | ''findMenu()'' | findMenu | 61 | |
| | public | ''findMenuParent()'' | findMenuParent | 90 | | | public | ''findMenuParent()'' | findMenuParent | 90 | |
| | public | ''insertMenu()'' | insertMenu() | 110 | | | public | ''insertMenu()'' | insertMenu() | 110 | |
| | public | ''updateMenu()'' | Update menu | 151 | | | public | ''updateMenu()'' | Update menu | 151 | |
| | public | ''activateMenu()'' | Activate menu | 181 | | | public | ''activateMenu()'' | Activate menu | 181 | |
| | public | ''deactivateMenu()'' | Deactivate menu | 194 | | | public | ''deactivateMenu()'' | Deactivate menu | 194 | |
| | public | ''deleteMenu()'' | Delete menu | 207 | | | public | ''deleteMenu()'' | Delete menu | 207 | |
| | public | ''checkMenuId()'' | Check menu id | 221 | | | public | ''checkMenuId()'' | Check menu id | 221 | |
| | public | ''menuExists()'' | Menu parent does exists or not | 241 | | | public | ''menuExists()'' | Menu parent does exists or not | 241 | |
| | public | ''dropDownMenuParent()'' | dropDownMenuParent | 259 | | | public | ''dropDownMenuParent()'' | dropDownMenuParent | 259 | |
| | public | ''dropDownMenuVisibility()'' | dropDownMenuVisibility | 300 | | | public | ''dropDownMenuVisibility()'' | dropDownMenuVisibility | 300 | |
| | public | ''dropDownLocale()'' | Drop down locale | 321 | | | public | ''dropDownLocale()'' | Drop down locale | 321 | |
| | public | ''totalMenuRecords()'' | Total menu records | 338 | | | public | ''totalMenuRecords()'' | Total menu records | 338 | |
| | private | ''updateMenuSort()'' | updateMenuSort | 353 | | | private | ''updateMenuSort()'' | updateMenuSort | 353 | |
| |
| |
| Find all menus | Find all menus |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$orderBy'' | ''(untyped)'' | '''menu_sort''' | //none// | | | ''$orderBy'' | ''(untyped)'' | '''menu_sort''' | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| findMenu | findMenu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menuId'' | ''(untyped)'' | //required// | //none// | | | ''$menuId'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — boolean|array|object | **Returns:** ''(none declared)'' — boolean|array|object |
| findMenuParent | findMenuParent |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$parentId'' | ''(untyped)'' | //required// | //none// | | | ''$parentId'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| insertMenu() | insertMenu() |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$bind'' | ''(untyped)'' | //required// | //none// | | | ''$bind'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Update menu | Update menu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | |
| | ''$bind'' | ''(untyped)'' | //required// | //none// | | | ''$bind'' | ''(untyped)'' | //required// | //none// | |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Activate menu | Activate menu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Deactivate menu | Deactivate menu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Delete menu | Delete menu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | | ''$sanitize'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Check menu id | Check menu id |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — numeric | **Returns:** ''(none declared)'' — numeric |
| Menu parent does exists or not | Menu parent does exists or not |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_label'' | ''(untyped)'' | //required// | //none// | | | ''$menu_label'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| Retrieving menu ID to drop down menu parent | Retrieving menu ID to drop down menu parent |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | '''''' | //none// | | | ''$selected'' | ''(untyped)'' | '''''' | //none// | |
| |
| **Returns:** ''(none declared)'' — void | **Returns:** ''(none declared)'' — void |
| dropDownMenuVisibility | dropDownMenuVisibility |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | '''''' | //none// | | | ''$selected'' | ''(untyped)'' | '''''' | //none// | |
| |
| **Returns:** ''(none declared)'' — string | **Returns:** ''(none declared)'' — string |
| Drop down locale | Drop down locale |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | ''""'' | //none// | | | ''$selected'' | ''(untyped)'' | ''""'' | //none// | |
| |
| **Returns:** ''(none declared)'' — string | **Returns:** ''(none declared)'' — string |
| Total menu records | Total menu records |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$data'' | ''array'' | ''[]'' | = null | | | ''$data'' | ''array'' | ''[]'' | = null | |
| |
| **Returns:** ''?int'' — integer|numeric | **Returns:** ''?int'' — integer|numeric |
| updateMenuSort | updateMenuSort |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$old_sort'' | ''(untyped)'' | //required// | //none// | | | ''$old_sort'' | ''(untyped)'' | //required// | //none// | |
| | ''$new_sort'' | ''(untyped)'' | //required// | //none// | | | ''$new_sort'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| ======= Imports ======= | ======= Imports ======= |
| |
| ^ Alias ^ Fully-qualified name ^ | ^ Alias ^ Fully-qualified name ^ |
| | ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] | | | ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] | |
| |
| |