CmsAdminMenuItem
in package
FinalYes
Base module class.
All modules should inherit and extend this class with their functionality.
Tags
Table of Contents
Properties
- $action : string
- $icon : string
- $module : string
- $priority : int
- $section : string
- $title : string
- $url : string
Methods
- from_module() : mixed
- A convenience method to build a standard admin menu item from module methods.
- valid() : mixed
- Test if the object is valid
Properties
$action
public
string
$action
The module action
$icon
public
string
$icon
The URL to the icon to associate with this action
$module
public
string
$module
The module that hosts the destination action
$priority
public
int
$priority
Priority for the menu item (minimum of 2)
$section
public
string
$section
The admin section (from CMSModule::GetAdminSection)
$title
public
string
$title
The title of the menu item
$url
public
string
$url
The actual URL for the menu item link. If this is not specified, it is created from the module and action.
Methods
from_module()
A convenience method to build a standard admin menu item from module methods.
public
static & from_module(CMSModule $mod) : mixed
Parameters
- $mod : CMSModule
valid()
Test if the object is valid
public
valid() : mixed