ModuleAdmin
in package
implements
ModuleAdmin
The module admin class for set permissions, menu items.
Tags
Table of Contents
Interfaces
- ModuleAdmin
- Module admin interface.
Properties
- $Container : Container
Methods
- __construct() : mixed
- The class constructor.
- dashboardWidgets() : array<string|int, mixed>
- Get admin dashboard (admin home) widgets HTML.
- definePermissions() : array<string|int, mixed>
- Define module's permissions.
- menuItems() : array<string|int, mixed>
- Set the menu items.
- permissionDisplayText() : mixed
- Set display text for each permission page, action.
Properties
$Container
protected
Container
$Container
Methods
__construct()
The class constructor.
public
__construct(Container $Container) : mixed
Parameters
- $Container : Container
-
The DI container class.
dashboardWidgets()
Get admin dashboard (admin home) widgets HTML.
public
dashboardWidgets() : array<string|int, mixed>
Return values
array<string|int, mixed> —Return array of admin dashboard widgets. Each array item contain one widget.
definePermissions()
Define module's permissions.
public
definePermissions() : array<string|int, mixed>
Return values
array<string|int, mixed> —Return the module's permissions in associative array.
menuItems()
Set the menu items.
public
menuItems() : array<string|int, mixed>
Return values
array<string|int, mixed> —Return the menu items for this module.
permissionDisplayText()
Set display text for each permission page, action.
public
permissionDisplayText([string $key = '' ][, bool $translate = false ]) : mixed
Parameters
- $key : string = ''
-
To get specific display text for the permission keyword, set the keyword here and it will return readable text value.
- $translate : bool = false
-
Set to
false(default) to not translate, set totrueto translate it. The translation will work only if$keyargument is not empty.
Return values
mixed —Return associative array where key is permission keyword if no keyword specified in parameter.
Return string (or empty string) if permission keyword is specified in parameter.