| Next revision | Previous revision |
| scriptlog:lib:service:menuservice [2026/09/26 09:09] – admin admin | scriptlog:lib:service:menuservice [2026/09/26 09:34] (current) – admin admin |
|---|
| ======= Docblock Metadata ======= | ======= Docblock Metadata ======= |
| |
| ^ Tag ^ Value ^ | ^ Tag ^ Value ^ |
| | ''@category'' | Service Class | | | ''@category'' | Service 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 ======= |
| //None.// | //None.// |
| |
| ======= Properties (0) ======= | ======= Properties (11) ======= |
| |
| //None declared.// | ^ Visibility ^ Type ^ Name ^ Default ^ Line ^ |
| | | ''private'' | ''(untyped)'' | ''$menu_id'' | | 30 | |
| | | ''private'' | ''(untyped)'' | ''$parent_id'' | | 38 | |
| | | ''private'' | ''(untyped)'' | ''$label'' | | 46 | |
| | | ''private'' | ''(untyped)'' | ''$link'' | | 54 | |
| | | ''private'' | ''(untyped)'' | ''$status'' | | 62 | |
| | | ''private'' | ''(untyped)'' | ''$visibility'' | | 70 | |
| | | ''private'' | ''(untyped)'' | ''$sort'' | | 78 | |
| | | ''private'' | ''(untyped)'' | ''$menu_locale'' | | 86 | |
| | | ''private'' | ''(untyped)'' | ''$menuDao'' | | 94 | |
| | | ''private'' | ''(untyped)'' | ''$validator'' | | 102 | |
| | | ''private'' | ''(untyped)'' | ''$sanitize'' | | 110 | |
| |
| ======= Methods (22) ======= | ======= Methods (22) ======= |
| |
| ^ Visibility ^ Method ^ Summary ^ Line ^ | ^ Visibility ^ Method ^ Summary ^ Line ^ |
| | public | ''__construct()'' | (undocumented) | 112 | | | public | ''__construct()'' | (undocumented) | 112 | |
| | public | ''setMenuId()'' | setMenuId | 125 | | | public | ''setMenuId()'' | setMenuId | 125 | |
| | public | ''setParentId()'' | setParentId | 136 | | | public | ''setParentId()'' | setParentId | 136 | |
| | public | ''setMenuLabel()'' | setMenuLabel | 147 | | | public | ''setMenuLabel()'' | setMenuLabel | 147 | |
| | public | ''setMenuLink()'' | setMenuLink | 158 | | | public | ''setMenuLink()'' | setMenuLink | 158 | |
| | public | ''setMenuVisibility()'' | setMenuVisibility | 169 | | | public | ''setMenuVisibility()'' | setMenuVisibility | 169 | |
| | public | ''setMenuOrder()'' | setMenuOrder | 180 | | | public | ''setMenuOrder()'' | setMenuOrder | 180 | |
| | public | ''setMenuStatus()'' | setMenuStatus | 191 | | | public | ''setMenuStatus()'' | setMenuStatus | 191 | |
| | public | ''setMenuLocale()'' | setMenuLocale | 202 | | | public | ''setMenuLocale()'' | setMenuLocale | 202 | |
| | public | ''grabMenus()'' | grabMenus | 214 | | | public | ''grabMenus()'' | grabMenus | 214 | |
| | public | ''grabMenu()'' | grabMenu | 226 | | | public | ''grabMenu()'' | grabMenu | 226 | |
| | public | ''grabMenuParent()'' | grabMenuParent | 238 | | | public | ''grabMenuParent()'' | grabMenuParent | 238 | |
| | public | ''addMenu()'' | addMenu | 249 | | | public | ''addMenu()'' | addMenu | 249 | |
| | public | ''modifyMenu()'' | modifyMenu | 274 | | | public | ''modifyMenu()'' | modifyMenu | 274 | |
| | public | ''enableMenu()'' | enableMenu() | 298 | | | public | ''enableMenu()'' | enableMenu() | 298 | |
| | public | ''disableMenu()'' | disableMenu() | 315 | | | public | ''disableMenu()'' | disableMenu() | 315 | |
| | public | ''removeMenu()'' | removeMenu() | 331 | | | public | ''removeMenu()'' | removeMenu() | 331 | |
| | public | ''parentDropDown()'' | parentDropDown | 348 | | | public | ''parentDropDown()'' | parentDropDown | 348 | |
| | public | ''visibilityDropDown()'' | visibilityDropDown() | 359 | | | public | ''visibilityDropDown()'' | visibilityDropDown() | 359 | |
| | public | ''localeDropDown()'' | localeDropDown | 371 | | | public | ''localeDropDown()'' | localeDropDown | 371 | |
| | public | ''isMenuExists()'' | isMenuExists | 382 | | | public | ''isMenuExists()'' | isMenuExists | 382 | |
| | public | ''totalMenus()'' | totalMenus | 393 | | | public | ''totalMenus()'' | totalMenus | 393 | |
| |
| |
| //lines 112–117 (6)// | //lines 112–117 (6)// |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menuDao'' | [[scriptlog:lib:dao:menudao|''MenuDao'']] | //required// | //none// | | | ''$menuDao'' | [[scriptlog:lib:dao:menudao|''MenuDao'']] | //required// | //none// | |
| | ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// | | | ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// | |
| | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// | | | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// | |
| |
| |
| setMenuId | setMenuId |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_id'' | ''(untyped)'' | //required// | //none// | | | ''$menu_id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setParentId | setParentId |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$parent_id'' | ''(untyped)'' | //required// | //none// | | | ''$parent_id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuLabel | setMenuLabel |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_label'' | ''(untyped)'' | //required// | //none// | | | ''$menu_label'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuLink | setMenuLink |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_link'' | ''(untyped)'' | //required// | //none// | | | ''$menu_link'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuVisibility | setMenuVisibility |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_visibility'' | ''(untyped)'' | //required// | //none// | | | ''$menu_visibility'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuOrder | setMenuOrder |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$sort'' | ''(untyped)'' | //required// | //none// | | | ''$sort'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuStatus | setMenuStatus |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_status'' | ''(untyped)'' | //required// | //none// | | | ''$menu_status'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| setMenuLocale | setMenuLocale |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_locale'' | ''(untyped)'' | //required// | //none// | | | ''$menu_locale'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| grabMenus | grabMenus |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$orderBy'' | ''(untyped)'' | ''"ID"'' | //none// | | | ''$orderBy'' | ''(untyped)'' | ''"ID"'' | //none// | |
| |
| **Returns:** ''(none declared)'' — mixed | **Returns:** ''(none declared)'' — mixed |
| grabMenu | grabMenu |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$id'' | ''(untyped)'' | //required// | //none// | | | ''$id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — mixed | **Returns:** ''(none declared)'' — mixed |
| grabMenuParent | grabMenuParent |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$parent_id'' | ''(untyped)'' | //required// | //none// | | | ''$parent_id'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' — mixed | **Returns:** ''(none declared)'' — mixed |
| parentDropDown | parentDropDown |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | ''""'' | //none// | | | ''$selected'' | ''(untyped)'' | ''""'' | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| visibilityDropDown() | visibilityDropDown() |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | ''""'' | //none// | | | ''$selected'' | ''(untyped)'' | ''""'' | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| localeDropDown | localeDropDown |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$selected'' | ''(untyped)'' | ''""'' | //none// | | | ''$selected'' | ''(untyped)'' | ''""'' | //none// | |
| |
| **Returns:** ''(none declared)'' — string | **Returns:** ''(none declared)'' — string |
| isMenuExists | isMenuExists |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$menu_label'' | ''(untyped)'' | //required// | //none// | | | ''$menu_label'' | ''(untyped)'' | //required// | //none// | |
| |
| **Returns:** ''(none declared)'' | **Returns:** ''(none declared)'' |
| totalMenus | totalMenus |
| |
| ^ Parameter ^ Type ^ Default ^ Description ^ | ^ Parameter ^ Type ^ Default ^ Description ^ |
| | ''$data'' | ''array'' | ''[]'' | //none// | | | ''$data'' | ''array'' | ''[]'' | //none// | |
| |
| **Returns:** ''?int'' | **Returns:** ''?int'' |
| ======= Imports ======= | ======= Imports ======= |
| |
| ^ Alias ^ Fully-qualified name ^ | ^ Alias ^ Fully-qualified name ^ |
| | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | | | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | |
| | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | |
| | ''MenuDao'' | [[scriptlog:lib:dao:menudao|''Scriptlog\Dao\MenuDao'']] | | | ''MenuDao'' | [[scriptlog:lib:dao:menudao|''Scriptlog\Dao\MenuDao'']] | |
| |
| |