HelpToolbarItem implements ToolbarItemInterface
Help toolbar item
Table of Contents
Interfaces
- ToolbarItemInterface
- Interface for classes which extend the backend by adding items to the top toolbar
Properties
Methods
- __construct() : mixed
- Constructor
- 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
- getFluidTemplateObject() : StandaloneView
- Returns a new standalone view, shorthand function
Properties
$helpModuleMenu
protected
BackendModule
$helpModuleMenu
Methods
__construct()
Constructor
public
__construct() : mixed
checkAccess()
Users see this if a module is available
public
checkAccess() : bool
Return values
bool —TRUE
getAdditionalAttributes()
No additional attributes needed.
public
getAdditionalAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getDropDown()
Render drop down
public
getDropDown() : string
Return values
stringgetIndex()
Position relative to others
public
getIndex() : int
Return values
intgetItem()
Render help icon
public
getItem() : string
Return values
string —toolbar item for the help icon
hasDropDown()
This item has a drop down
public
hasDropDown() : bool
Return values
boolgetFluidTemplateObject()
Returns a new standalone view, shorthand function
protected
getFluidTemplateObject(string $filename) : StandaloneView
Parameters
- $filename : string
-
Which templateFile should be used.