WorkspaceSelectorToolbarItem implements ToolbarItemInterface, RequestAwareToolbarItemInterface
Class to render the workspace selector
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
- $availableWorkspaces : array<string|int, mixed>
Methods
- __construct() : mixed
- checkAccess() : bool
- Checks whether the user has access to this toolbar item.
- getAdditionalAttributes() : array<string|int, mixed>
- This toolbar needs no additional attributes.
- getDropDown() : string
- Render drop-down.
- getIndex() : int
- Position relative to others
- getItem() : string
- Render item.
- hasDropDown() : bool
- This item has a drop-down.
- setRequest() : void
- getBackendUser() : BackendUserAuthentication
Properties
$availableWorkspaces
protected
array<string|int, mixed>
$availableWorkspaces
Methods
__construct()
public
__construct(WorkspaceService $workspaceService, UriBuilder $uriBuilder, BackendViewFactory $backendViewFactory, ModuleProvider $moduleProvider) : mixed
Parameters
- $workspaceService : WorkspaceService
- $uriBuilder : UriBuilder
- $backendViewFactory : BackendViewFactory
- $moduleProvider : ModuleProvider
checkAccess()
Checks whether the user has access to this toolbar item.
public
checkAccess() : bool
Return values
bool —TRUE if user has access, FALSE if not
getAdditionalAttributes()
This toolbar needs no additional attributes.
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 item.
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