WorkspaceAspect implements AspectInterface
The aspect contains information about the currently accessed workspace.
Allowed properties:
- id
- isLive
- isOffline
Table of Contents
Interfaces
- AspectInterface
- Interface AspectInterface Think of an aspect like a property bag
Properties
- $workspaceId : int
Methods
- __construct() : mixed
- get() : int|bool
- Fetch the workspace ID, or evaluated the state if it's 'online' or 'offline'
- getId() : int
- Return the workspace ID
- isLive() : bool
- Return whether this is live workspace or in a custom offline workspace
Properties
$workspaceId
protected
int
$workspaceId
Methods
__construct()
public
__construct([int $workspaceId = 0 ]) : mixed
Parameters
- $workspaceId : int = 0
get()
Fetch the workspace ID, or evaluated the state if it's 'online' or 'offline'
public
get(string $name) : int|bool
Parameters
- $name : string
Tags
Return values
int|boolgetId()
Return the workspace ID
public
getId() : int
Return values
intisLive()
Return whether this is live workspace or in a custom offline workspace
public
isLive() : bool