Interface luya\admin\components\AdminMenuBuilderInterface

All Classes | Methods

Implemented by	luya\admin\components\AdminMenuBuilder
Available since version	1.0.0
Source Code	https://github.com/luyadev/luya-module-admin/blob/master/src/components/AdminMenuBuilderInterface.php

Interface of the AdminMenuBuilder class.

If the AdminMenuBuilder class is instance of the AdminMenuBuilderInterface we can ensure to get the menu data with menu() method.

Public Methods

Hide inherited methods

Method	Description	Defined By
getPermissionApis()		luya\admin\components\AdminMenuBuilderInterface
getPermissionRoutes()		luya\admin\components\AdminMenuBuilderInterface
menu()	Get the Menu Array.	luya\admin\components\AdminMenuBuilderInterface

Method Details

Hide inherited methods

getPermissionApis() public abstract method

public abstract void getPermissionApis ( )

Source code

                public function getPermissionApis();

getPermissionRoutes() public abstract method

public abstract void getPermissionRoutes ( )

Source code

                public function getPermissionRoutes();

menu() public abstract method

Get the Menu Array.

Example Response:

Array (
[moduleId] => admin
[template] =>
[routing] => default
[alias] => menu_node_system
[icon] => layers
[permissionRoute] =>
[permissionIsRoute] =>
[searchModelClass] =>
[groups] => Array (
       [menu_group_access] => Array  (
              [name] => menu_group_access
              [items] => Array  (
                      [0] => Array (
                              [alias] => menu_access_item_user
                              [route] => admin/user/index
                              [icon] => person
                              [permissionApiEndpoint] => api-admin-user
                              [permissionIsRoute] =>
                              [permissionIsApi] => 1
                              [searchModelClass] =>
                              [options] => Array ()
                          )
                      [1] => Array  (
                              [alias] => menu_access_item_group
                              [route] => admin/group/index
                              [icon] => group
                              [permissionApiEndpoint] => api-admin-group
                              [permissionIsRoute] =>
                              [permissionIsApi] => 1
                              [searchModelClass] =>
                              [options] => Array ( )
                          )
                  )
          )
)

public abstract array menu ( )
return	array	The menu array with all its nodes, subnodes routes and apis.

Source code

                public function menu();