HelpToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface
Help toolbar item - The question mark icon in toolbar
Table of Contents
Interfaces
- ToolbarItemInterface
- Interface for classes which extend the backend by adding items to the top toolbar
- RequestAwareToolbarItemInterface
- Interface for toolbar items that need the ServerRequestInterface Request.
Properties
- $helpModule : MenuModule|null
Methods
- __construct() : mixed
- checkAccess() : bool
- Users see this if a module is available
- getAdditionalAttributes() : array<string|int, mixed>
- No additional attributes needed.
- getDropDown() : string
- Render drop down
- getIndex() : int
- Position relative to others
- getItem() : string
- Render help icon
- hasDropDown() : bool
- This item has a drop-down
- setRequest() : void
- getBackendUser() : BackendUserAuthentication
Properties
$helpModule
protected
MenuModule|null
$helpModule
= null
Methods
__construct()
public
__construct(ModuleProvider $moduleProvider, BackendViewFactory $backendViewFactory) : mixed
Parameters
- $moduleProvider : ModuleProvider
- $backendViewFactory : BackendViewFactory
checkAccess()
Users see this if a module is available
public
checkAccess() : bool
Return values
bool —TRUE if user has access, FALSE if not
getAdditionalAttributes()
No additional attributes needed.
public
getAdditionalAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —List item HTML attributes
getDropDown()
Render drop down
public
getDropDown() : string
Return values
string —Drop down HTML
getIndex()
Position relative to others
public
getIndex() : int
Return values
int —0 .. 100
getItem()
Render help icon
public
getItem() : string
Return values
string —Toolbar item HTML
hasDropDown()
This item has a drop-down
public
hasDropDown() : bool
Return values
boolsetRequest()
public
setRequest(ServerRequestInterface $request) : void
Parameters
- $request : ServerRequestInterface
getBackendUser()
protected
getBackendUser() : BackendUserAuthentication