智简魔方文档

获取前台导航

方法概览

项目内容
文档类型PHP 函数
方法标识/admin/v1/menu/home
所属业务站点内容
来源模块/系统导航管理模型

功能说明

获取前台导航

调用示例

$result = (new \app\common\model\MenuModel())->getHomeMenu();

参数

该函数/方法无需传入参数。

返回值

返回项类型说明
menuarray菜单
menu[].idint菜单ID
menu[].typestring菜单类型system系统plugin插件custom自定义module模块
menu[].namestring名称
menu[].languageobject语言
menu[].urlstring网址
menu[].second_reminderint二次提醒0否1是
menu[].iconstring图标
menu[].nav_idint导航ID
menu[].parent_idint父ID
menu[].modulestring模块类型
menu[].res_modulearrayres模块类型
menu[].product_idarray包含商品
menu[].childarray子菜单
menu[].child[].idint菜单ID
menu[].child[].typestring菜单类型system系统plugin插件custom自定义module模块
menu[].child[].namestring名称
menu[].child[].languageobject语言
menu[].child[].urlstring网址
menu[].child[].second_reminderint二次提醒0否1是
menu[].child[].iconstring图标
menu[].child[].nav_idint导航ID
menu[].child[].parent_idint父ID
menu[].child[].modulestring模块类型
menu[].child[].res_modulearrayres模块类型
menu[].child[].product_idarray包含商品
languagearray语言
language[].display_namestring语言名称
language[].display_flagstring国家代码
language[].display_imgstring图片
language[].display_langstring语言标识
system_navarray系统默认导航
system_nav[].idstring导航ID
system_nav[].namestring名称
system_nav[].urlstring网址
plugin_navarray插件默认导航
plugin_nav[].titlestring插件标题
plugin_nav[].navarray插件导航
plugin_nav[].nav[].idint导航ID
plugin_nav[].nav[].namestring名称
plugin_nav[].nav[].urlstring网址
modulearray模块
module[].namestring模块名称
module[].display_namestring模块显示名称
res_modulearray上游模块
res_module[].namestring上游模块名称
res_module[].display_namestring上游模块显示名称

正常返回

{
  "menu": [
    {
      "id": 1,
      "type": "string",
      "name": "示例名称",
      "language": {},
      "url": "https://example.com/callback",
      "second_reminder": 1,
      "icon": "string",
      "nav_id": 1,
      "parent_id": 1,
      "module": "string",
      "res_module": [
        "string"
      ],
      "product_id": [
        1
      ],
      "child": [
        {
          "id": 1,
          "type": "string",
          "name": "示例名称",
          "language": {},
          "url": "https://example.com/callback",
          "second_reminder": 1,
          "icon": "string",
          "nav_id": 1,
          "parent_id": 1,
          "module": "string",
          "res_module": [
            "string"
          ],
          "product_id": [
            1
          ]
        }
      ]
    }
  ],
  "language": [
    {
      "display_name": "zh-cn",
      "display_flag": "zh-cn",
      "display_img": "zh-cn",
      "display_lang": "zh-cn"
    }
  ],
  "system_nav": [
    {
      "id": "string",
      "name": "示例名称",
      "url": "https://example.com/callback"
    }
  ],
  "plugin_nav": [
    {
      "title": "示例名称",
      "nav": [
        {
          "id": 1,
          "name": "示例名称",
          "url": "https://example.com/callback"
        }
      ]
    }
  ],
  "module": [
    {
      "name": "示例名称",
      "display_name": "示例名称"
    }
  ],
  "res_module": [
    {
      "name": "示例名称",
      "display_name": "示例名称"
    }
  ]
}

异常情况

异常类型说明
Throwable调用失败时由具体实现抛出异常,异常信息以运行时结果为准。