Joomla! API

下载
启动

AbstractMenu

菜单类

抽象
自

1.5
包

Joomla CMS

方法

__construct

类构造函数

__construct(mixed||string|int options = []) :
自

1.5

参数

options

array<string|int, mixed>配置选项数组。

响应

混合

__get

用户对象的魔法获取器。如果存在，则返回注入的对象，如果不存在，则返回当前对象。

__get( propName) : \Joomla\CMS\User\User|null

使用魔法获取器来保留 B/C，因为我们在构建菜单对象时不再存储用户对象。由于用户属性不再初始化，此获取器可确保扩展此类的任何类仍然可以使用 $instance->user 并获取正确的值。

自

3.9.26

参数

propName

string缺少或受保护属性的名称。

响应

User|null

authorise

方法用于检查菜单对象授权是否符合访问控制对象，并可选地符合访问扩展对象

authorise( id) :
自

1.5

参数

id

int菜单 ID

响应

bool

getActive

通过 ID 获取菜单项。

getActive() : \Joomla\CMS\Menu\MenuItem|null
自

1.5

响应

MenuItem|null如果已设置活动菜单项，则为项对象，否则为 null

getDefault

通过语言代码获取默认项。

getDefault( language = '*') : \Joomla\CMS\Menu\MenuItem|null
自

1.5

参数

language

string语言代码，默认值为 * 表示全部。

响应

MenuItem|null项对象或在找不到给定语言时为 null

getInstance

返回菜单对象

getInstance( client, mixed||string|int options = []) : \Joomla\CMS\Menu\AbstractMenu
static 已弃用
自

1.5
抛出

异常
已弃用

4.3 将在 6.0 中删除 使用容器中的 MenuFactoryInterface 示例：Factory::getContainer()->get(MenuFactoryInterface::class)->createMenu($client, $options)

参数

client

string客户端的名称

options

array<string|int, mixed>选项的关联数组

响应

AbstractMenu菜单对象。

getItem

通过 ID 获取菜单项

getItem( id) : \Joomla\CMS\Menu\MenuItem|null
自

1.5

参数

id

int项 ID

响应

MenuItem|null如果 ID 存在，则为项对象，如果未找到，则为 null

getItems

通过属性获取菜单项

getItems( attributes,  values,  firstonly = false) : \Joomla\CMS\Menu\MenuItem|\Joomla\CMS\Menu\MenuItem[]
自

1.5

参数

attributes

mixed字段名称。

values

mixed字段的值。如果为数组，则需要匹配每个属性可能具有多个值的字段名称，以查找这些值。

firstonly

bool如果为真，则仅返回找到的第一个项

响应

MenuItem|array<string|int, MenuItem>菜单项对象的数组，如果 $firstonly 参数为真，则为单个对象

getMenu

菜单数组的获取器

getMenu() : \Joomla\CMS\Menu\MenuItem||string|int
自

1.5

响应

array<string|int, MenuItem>

getParams

获取特定菜单项的参数对象

getParams( id) : \Joomla\Registry\Registry
自

1.5

参数

id

int项 ID

响应

Registry

getUser

用户的内部获取器。如果存在，则返回注入的对象，如果不存在，则返回当前对象。

getUser() : \Joomla\CMS\User\User
自

3.9.26

响应

User

load

加载菜单项

load() : mixed||string|int
抽象
自

1.5

响应

array<string|int, mixed>

setActive

通过 ID 设置默认项

setActive( id) : \Joomla\CMS\Menu\MenuItem|null
自

1.5

参数

id

int项 ID

响应

MenuItem|null如果存在，则表示给定 ID 的菜单项，否则为 null

setDefault

通过 ID 和语言代码设置默认项。

setDefault( id,  language = '*') :
自

1.5

参数

id

int菜单项 ID。

language

string语言代码（自 1.6 起）。

响应

bool如果存在具有给定 ID 的菜单项，则为真

setUser

用于构建菜单的当前用户的设置器。

setUser(\Joomla\CMS\User\User user) :
自

3.9.26

参数

user

User要设置的新用户。

响应

void

属性

items

用于保存菜单项的数组

自

4.0.0

类型

array<string|int, MenuItem>

default

默认菜单项的标识符。数组的键是语言。

自

4.0.0

类型

array<string|int, int>

active

活动菜单项的标识符

自

4.0.0

类型

int

instances

菜单实例容器。

static 已弃用
自

1.7
已弃用

4.3 将在 6.0 中删除 使用容器中的 MenuFactoryInterface 示例：Factory::getContainer()->get(MenuFactoryInterface::class)->createMenu($client, $options)

类型

array<string|int, AbstractMenu>

storedUser

用于检查访问级别的用户对象

自

3.9.26

类型

User

itemsLoaded

用于检查是否已加载菜单项的标志

自

4.0.0

类型

bool
  • \ Joomla
  • \ CMS
  • \ Menu
  • \ AbstractMenu