This is an old revision of the document!
Table of Contents
MenuService
Layer: Service · Source: lib/service/MenuService.php:22 (lines 22–397)
class MenuService
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 (22)
^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | (undocumented) | 112 | | public | ''setMenuId()'' | setMenuId | 125 | | public | ''setParentId()'' | setParentId | 136 | | public | ''setMenuLabel()'' | setMenuLabel | 147 | | public | ''setMenuLink()'' | setMenuLink | 158 | | public | ''setMenuVisibility()'' | setMenuVisibility | 169 | | public | ''setMenuOrder()'' | setMenuOrder | 180 | | public | ''setMenuStatus()'' | setMenuStatus | 191 | | public | ''setMenuLocale()'' | setMenuLocale | 202 | | public | ''grabMenus()'' | grabMenus | 214 | | public | ''grabMenu()'' | grabMenu | 226 | | public | ''grabMenuParent()'' | grabMenuParent | 238 | | public | ''addMenu()'' | addMenu | 249 | | public | ''modifyMenu()'' | modifyMenu | 274 | | public | ''enableMenu()'' | enableMenu() | 298 | | public | ''disableMenu()'' | disableMenu() | 315 | | public | ''removeMenu()'' | removeMenu() | 331 | | public | ''parentDropDown()'' | parentDropDown | 348 | | public | ''visibilityDropDown()'' | visibilityDropDown() | 359 | | public | ''localeDropDown()'' | localeDropDown | 371 | | public | ''isMenuExists()'' | isMenuExists | 382 | | public | ''totalMenus()'' | totalMenus | 393 |
__construct()
public function __construct(MenuDao $menuDao, FormValidator $validator, Sanitize $sanitize)
lines 112–117 (6)
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menuDao'' | [[scriptlog:lib:dao:menudao|''MenuDao'']] | //required// | //none// | | ''$validator'' | [[scriptlog:lib:core:formvalidator|''FormValidator'']] | //required// | //none// | | ''$sanitize'' | [[scriptlog:lib:core:sanitize|''Sanitize'']] | //required// | //none// |
setMenuId()
public function setMenuId($menu_id)
lines 125–128 (4)
setMenuId
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setParentId()
public function setParentId($parent_id)
lines 136–139 (4)
setParentId
^ Parameter ^ Type ^ Default ^ Description ^ | ''$parent_id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuLabel()
public function setMenuLabel($menu_label)
lines 147–150 (4)
setMenuLabel
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_label'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuLink()
public function setMenuLink($menu_link)
lines 158–161 (4)
setMenuLink
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_link'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuVisibility()
public function setMenuVisibility($menu_visibility)
lines 169–172 (4)
setMenuVisibility
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_visibility'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuOrder()
public function setMenuOrder($sort)
lines 180–183 (4)
setMenuOrder
^ Parameter ^ Type ^ Default ^ Description ^ | ''$sort'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuStatus()
public function setMenuStatus($menu_status)
lines 191–194 (4)
setMenuStatus
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_status'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
setMenuLocale()
public function setMenuLocale($menu_locale)
lines 202–205 (4)
setMenuLocale
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_locale'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
grabMenus()
public function grabMenus($orderBy = "ID")
lines 214–217 (4)
grabMenus
^ Parameter ^ Type ^ Default ^ Description ^ | ''$orderBy'' | ''(untyped)'' | ''"ID"'' | //none// |
Returns: (none declared) — mixed
grabMenu()
public function grabMenu($id)
lines 226–229 (4)
grabMenu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared) — mixed
grabMenuParent()
public function grabMenuParent($parent_id)
lines 238–241 (4)
grabMenuParent
^ Parameter ^ Type ^ Default ^ Description ^ | ''$parent_id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared) — mixed
addMenu()
public function addMenu()
lines 249–268 (20)
addMenu
Takes no parameters.
Returns: (none declared) — mixed
modifyMenu()
public function modifyMenu()
lines 274–292 (19)
modifyMenu
Takes no parameters.
Returns: (none declared)
enableMenu()
public function enableMenu()
lines 298–309 (12)
enableMenu()
Takes no parameters.
Returns: (none declared)
disableMenu()
public function disableMenu()
lines 315–325 (11)
disableMenu()
Takes no parameters.
Returns: (none declared)
removeMenu()
public function removeMenu()
lines 331–340 (10)
removeMenu()
Takes no parameters.
Returns: (none declared)
parentDropDown()
public function parentDropDown($selected = "")
lines 348–351 (4)
parentDropDown
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | ''""'' | //none// |
Returns: (none declared)
visibilityDropDown()
public function visibilityDropDown($selected = "")
lines 359–362 (4)
visibilityDropDown()
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | ''""'' | //none// |
Returns: (none declared)
localeDropDown()
public function localeDropDown($selected = "")
lines 371–374 (4)
localeDropDown
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | ''""'' | //none// |
Returns: (none declared) — string
isMenuExists()
public function isMenuExists($menu_label)
lines 382–385 (4)
isMenuExists
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_label'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
totalMenus()
public function totalMenus(array $data = []): ?int
lines 393–396 (4)
totalMenus
^ Parameter ^ Type ^ Default ^ Description ^ | ''$data'' | ''array'' | ''[]'' | //none// |
Returns: ?int
Imports
^ Alias ^ Fully-qualified name ^ | ''FormValidator'' | [[scriptlog:lib:core:formvalidator|''Scriptlog\Core\FormValidator'']] | | ''Sanitize'' | [[scriptlog:lib:core:sanitize|''Scriptlog\Core\Sanitize'']] | | ''MenuDao'' | [[scriptlog:lib:dao:menudao|''Scriptlog\Dao\MenuDao'']] |
This page is generated from source by 'tools/gendoc'. Edits will be overwritten.
