CmsAdminMenuItem View code

A class to represent menu items for building an admin navigation.

This class is used to build admin navigations.

package

CMS

since 2.0
license

GPL

author

Robert Campbell calguy1000@cmsmadesimple.org

see

Methods

valid() 

Test if the object is valid

from_module(\CMSModule $mod) 

A convenience method to build a standard admin menu item from module methods.

static

Arguments

\CMSModule $mod

Properties

module

module : string

The module that hosts the destination action

Type(s)

string

section

section : string

The admin section (from CMSModule::GetAdminSection)

Type(s)

string

title

title : string

The title of the menu item

Type(s)

string

action

action : string

The module action

Type(s)

string

url

url : string

The actual URL for the menu item link. If this is not specified, it is created from the module and action.

Type(s)

string

icon

icon : string

The URL to the icon to associate with this action

Type(s)

string

priority

priority : integer

Priority for the menu item (minimum of 2)

Type(s)

integer