Documentation

Menu

in package

• SMF

implements ArrayAccess uses ArrayAccessHelper

Represents a menu, such as the admin menu or profile menu.

string title:         Section title.

bool   enabled:       Should this section be accessible?

array  areas:         Array of areas within this section. (See below.)

array  permission:    Permission required to access the whole section.

string label:         Optional text string for link. If this is not set,
                      Lang::$txt[$area_id] will be used.

string file:          Name of source file required for this area.

string function:      Function to call when area is selected.

string custom_url:    URL to use for this menu item.

bool   enabled:       Should this area be accessible?

bool   hidden:        Should this area be visible? (Used when an area is
                      accessible but should not be shown.)

string select:        If set this item will not be displayed. Instead the
                      item indexed here will be.

array  subsections:   Array of subsections from this area. (See below.)

array  permission:    Array of permissions to determine who can access
                      this area.

For Subsections:

string label:         Text label for this subsection.

array  permission:    Array of permissions to check for this subsection.

bool   enabled:       Should this subsection be accessible?

bool   is_default:    Is this the default subaction? If no subsection is
                      set as the default, the first one will be used.

string action:        The action for this menu. If this is not set, it
                      will be determined automatically.

string current_area:  The currently selected area. If this is not set, it
                      will be determined automatically.

string base_url:      The base URL for items in this menu. If this is not
                      set, it will be determined automatically.

string template_name: The theme template to load for this menu.

string layer_name:    The template layer to load for this menu.

bool   do_big_icons:  If true, get large icons for admin home page.

array  extra_url_parameters:
                      Key-value pairs of extra parameters to append to
                      the menu item URLs.

bool   disable_url_session_check:
                      If true, does not append the session parameter to
                      the menu item URLs.

bool   disable_hook_call:
                      If true, skips the integrate_{action}_areas hook.

Table of Contents

Interfaces

ArrayAccess

Properties

$base_url  : string

$current_action  : string

$current_area  : string

$current_section  : string

$current_subsection  : string

$extra_parameters  : string

$id  : int

$include_data  : array<string|int, mixed>

$layer_name  : string

$loaded  : array<string|int, mixed>

$max_id  : int

$name  : string

$sections  : array<string|int, mixed>

$tab_data  : array<string|int, mixed>

$template_name  : string

$backup_area  : string

$data  : array<string|int, mixed>

$found_section  : bool

$options  : array<string|int, mixed>

Methods

__construct()  : mixed

Constructor.

create()  : array<string|int, mixed>|false

Static wrapper for constructor.

destroy()  : void

Delete a menu.

offsetExists()  : bool

Checks whether a property has been set when object is accessed as an array.

offsetGet()  : mixed

Gets properties when object is accessed as an array.

offsetSet()  : void

Sets properties when object is accessed as an array.

offsetUnset()  : void

Unsets properties when object is accessed as an array.

buildArea()  : void

Build the data array for an area of the menu.

buildExtraParameters()  : void

Build a list of additional parameters that should go in the URL.

buildSection()  : void

Build the data array for a section of the menu.

buildSubsection()  : void

Build the data array for a subsection of the menu.

checkBaseUrl()  : void

Goes through all the sections to check if the base menu has an url.

enabledAndAllowed()  : bool

Checks whether the given menu item is enabled and whether the current user has permission to access it.

setAreaIcon()  : void

Sets the icon for an area.

setCurrentSectionAndArea()  : void

Figures out which section and area the user is currently viewing.

setSelected()  : void

Figures out which section, area, and subsection are currently selected.