AdminMenu
in package
Class for managing Magrathea's Admin Menu
Table of Contents
Properties
- $menu : mixed
- $adminUrls : mixed
- $menuItems : mixed
Methods
- __construct() : mixed
- Add() : AdminMenu
- add an item or array of items to the menu
- CreateLink() : array<string|int, mixed>
- Create a Link Menu item
- CreateSpace() : array<string|int, mixed>
- Create an empty space
- CreateTitle() : array<string|int, mixed>
- Create a title menu item
- GetDatabaseSection() : array<string|int, mixed>
- Get database items array
- GetDebugSection() : array<string|int, mixed>
- Get debug items array
- GetHelpSection() : array<string|int, mixed>
- Get object items array
- GetItem() : array<string|int, mixed>
- get an item from the pre-existing menu items
- GetLogoutMenuItem() : array<string|int, mixed>
- Get item for user logout
- GetMenu() : array<string|int, mixed>
- Gets the working menu
- GetMenuFeatures() : array<string|int, mixed>
- Gets an array of features and add the menu items
- GetObjectSection() : array<string|int, mixed>
- Get object items array
- Initialize() : mixed
- IsMenuActive() : bool
- check if item menu is active
- SimpleItem() : array<string|int, mixed>
- creates a simple menu item
Properties
$menu
public
mixed
$menu
= []
$adminUrls
private
mixed
$adminUrls
$menuItems
private
mixed
$menuItems
= []
Methods
__construct()
public
__construct() : mixed
Add()
add an item or array of items to the menu
public
Add(array<string|int, mixed>|string $items) : AdminMenu
Parameters
- $items : array<string|int, mixed>|string
-
items to be added
Return values
AdminMenu —itself
CreateLink()
Create a Link Menu item
public
CreateLink(string $caption, string $link) : array<string|int, mixed>
Parameters
- $caption : string
-
item title
- $link : string
-
item link
Return values
array<string|int, mixed> —item object with link
CreateSpace()
Create an empty space
public
CreateSpace([mixed $class = null ]) : array<string|int, mixed>
Parameters
- $class : mixed = null
Return values
array<string|int, mixed> —empty space data
CreateTitle()
Create a title menu item
public
CreateTitle(string $t) : array<string|int, mixed>
Parameters
- $t : string
-
item title [ title, type ] (type = main|sub|empty|link)
Return values
array<string|int, mixed> —item object with title
GetDatabaseSection()
Get database items array
public
GetDatabaseSection() : array<string|int, mixed>
Return values
array<string|int, mixed> —items
GetDebugSection()
Get debug items array
public
GetDebugSection() : array<string|int, mixed>
Return values
array<string|int, mixed> —items
GetHelpSection()
Get object items array
public
GetHelpSection() : array<string|int, mixed>
Return values
array<string|int, mixed> —items
GetItem()
get an item from the pre-existing menu items
public
GetItem(string $item) : array<string|int, mixed>
Parameters
- $item : string
-
item key
Return values
array<string|int, mixed> —item for the menu
GetLogoutMenuItem()
Get item for user logout
public
GetLogoutMenuItem() : array<string|int, mixed>
Return values
array<string|int, mixed>GetMenu()
Gets the working menu
public
GetMenu() : array<string|int, mixed>
Return values
array<string|int, mixed> —menu;
GetMenuFeatures()
Gets an array of features and add the menu items
public
GetMenuFeatures(array<string|int, mixed> $features[, string $title = "Features" ]) : array<string|int, mixed>
Parameters
- $features : array<string|int, mixed>
-
features
- $title : string = "Features"
-
title for section (default: "Features")
Return values
array<string|int, mixed> —features menu items
GetObjectSection()
Get object items array
public
GetObjectSection() : array<string|int, mixed>
Return values
array<string|int, mixed> —items
Initialize()
public
Initialize() : mixed
IsMenuActive()
check if item menu is active
public
IsMenuActive(string $item) : bool
Parameters
- $item : string
-
item name
Return values
bool —is it?
SimpleItem()
creates a simple menu item
public
SimpleItem(string $title, string $page) : array<string|int, mixed>
Parameters
- $title : string
-
Title for the item
- $page : string
-
page that will be called
Return values
array<string|int, mixed> —menu item