This is an old revision of the document!
Table of Contents
MenuDao
Layer: DAO · Source: lib/dao/MenuDao.php:21 (lines 21–371)
class MenuDao extends Dao
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 (0)
None declared.
Methods (16)
^ Visibility ^ Method ^ Summary ^ Line ^ | public | ''__construct()'' | (undocumented) | 28 | | public | ''findMenus()'' | Find all menus | 40 | | public | ''findMenu()'' | findMenu | 61 | | public | ''findMenuParent()'' | findMenuParent | 90 | | public | ''insertMenu()'' | insertMenu() | 110 | | public | ''updateMenu()'' | Update menu | 151 | | public | ''activateMenu()'' | Activate menu | 181 | | public | ''deactivateMenu()'' | Deactivate menu | 194 | | public | ''deleteMenu()'' | Delete menu | 207 | | public | ''checkMenuId()'' | Check menu id | 221 | | public | ''menuExists()'' | Menu parent does exists or not | 241 | | public | ''dropDownMenuParent()'' | dropDownMenuParent | 259 | | public | ''dropDownMenuVisibility()'' | dropDownMenuVisibility | 300 | | public | ''dropDownLocale()'' | Drop down locale | 321 | | public | ''totalMenuRecords()'' | Total menu records | 338 | | private | ''updateMenuSort()'' | updateMenuSort | 353 |
__construct()
public function __construct()
lines 28–31 (4)
Takes no parameters.
findMenus()
public function findMenus($orderBy = 'menu_sort')
lines 40–50 (11)
Find all menus
^ Parameter ^ Type ^ Default ^ Description ^ | ''$orderBy'' | ''(untyped)'' | '''menu_sort''' | //none// |
Returns: (none declared)
findMenu()
public function findMenu($menuId, $sanitizing)
lines 61–81 (21)
findMenu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menuId'' | ''(untyped)'' | //required// | //none// | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared) — boolean|array|object
findMenuParent()
public function findMenuParent($parentId, $sanitizing)
lines 90–102 (13)
findMenuParent
^ Parameter ^ Type ^ Default ^ Description ^ | ''$parentId'' | ''(untyped)'' | //required// | //none// | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
insertMenu()
public function insertMenu($bind)
lines 110–143 (34)
insertMenu()
^ Parameter ^ Type ^ Default ^ Description ^ | ''$bind'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
updateMenu()
public function updateMenu($sanitize, $bind, $id)
lines 151–172 (22)
Update menu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$sanitize'' | ''(untyped)'' | //required// | //none// | | ''$bind'' | ''(untyped)'' | //required// | //none// | | ''$id'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
activateMenu()
public function activateMenu($id, $sanitize)
lines 181–185 (5)
Activate menu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
deactivateMenu()
public function deactivateMenu($id, $sanitize)
lines 194–198 (5)
Deactivate menu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
deleteMenu()
public function deleteMenu($id, $sanitize)
lines 207–211 (5)
Delete menu
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitize'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
checkMenuId()
public function checkMenuId($id, $sanitizing)
lines 221–233 (13)
Check menu id
^ Parameter ^ Type ^ Default ^ Description ^ | ''$id'' | ''(untyped)'' | //required// | //none// | | ''$sanitizing'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared) — numeric
menuExists()
public function menuExists($menu_label)
lines 241–248 (8)
Menu parent does exists or not
^ Parameter ^ Type ^ Default ^ Description ^ | ''$menu_label'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
dropDownMenuParent()
public function dropDownMenuParent($selected = '')
lines 259–291 (33)
dropDownMenuParent
Retrieving menu ID to drop down menu parent
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | '''''' | //none// |
Returns: (none declared) — void
dropDownMenuVisibility()
public function dropDownMenuVisibility($selected = '')
lines 300–312 (13)
dropDownMenuVisibility
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | '''''' | //none// |
Returns: (none declared) — string
dropDownLocale()
public function dropDownLocale($selected = "")
lines 321–328 (8)
Drop down locale
^ Parameter ^ Type ^ Default ^ Description ^ | ''$selected'' | ''(untyped)'' | ''""'' | //none// |
Returns: (none declared) — string
totalMenuRecords()
public function totalMenuRecords(array $data = []): ?int
lines 338–343 (6)
Total menu records
^ Parameter ^ Type ^ Default ^ Description ^ | ''$data'' | ''array'' | ''[]'' | = null |
Returns: ?int — integer|numeric
updateMenuSort()
private function updateMenuSort($old_sort, $new_sort)
lines 353–370 (18)
updateMenuSort
^ Parameter ^ Type ^ Default ^ Description ^ | ''$old_sort'' | ''(untyped)'' | //required// | //none// | | ''$new_sort'' | ''(untyped)'' | //required// | //none// |
Returns: (none declared)
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.
