WarehouseOnboarding
Table of Contents
Methods
- __construct() : mixed
- WarehouseOnboarding constructor.
- endFirstChain() : void
- End first onboarding chain if it is current and fix timestamp to start second onboarding chain
- getCurrentChainData() : array<string|int, mixed>
- Returns formatted onboarding data for user
- getOnboardingData() : array<string|int, mixed>
- Returns onboarding data for user
- isCrmWarehouseOnboardingAvailable() : bool
- Returns true if onboarding is available for shown to user
- isOver() : bool
- Returns true value if the user has nothing more to show from the hints
- isStoreDocumentChainStepAvailable() : bool
- Returns true if onboarding is available to show hint in the store document products grid
- setChainStep() : void
- Set step for the current onboarding chain
Methods
__construct()
WarehouseOnboarding constructor.
public
__construct(int $userID) : mixed
Parameters
- $userID : int
-
ID of User who belongs onoboarding data
endFirstChain()
End first onboarding chain if it is current and fix timestamp to start second onboarding chain
public
endFirstChain([int $startNextChainTimestamp = 0 ]) : void
Parameters
- $startNextChainTimestamp : int = 0
-
Timestamp for start second onboarding chain
getCurrentChainData()
Returns formatted onboarding data for user
public
getCurrentChainData() : array<string|int, mixed>
Return values
array<string|int, mixed>getOnboardingData()
Returns onboarding data for user
public
getOnboardingData() : array<string|int, mixed>
Return values
array<string|int, mixed>isCrmWarehouseOnboardingAvailable()
Returns true if onboarding is available for shown to user
public
static isCrmWarehouseOnboardingAvailable(int $userID) : bool
Parameters
- $userID : int
Tags
Return values
boolisOver()
Returns true value if the user has nothing more to show from the hints
public
isOver() : bool
Return values
boolisStoreDocumentChainStepAvailable()
Returns true if onboarding is available to show hint in the store document products grid
public
isStoreDocumentChainStepAvailable() : bool
Return values
boolsetChainStep()
Set step for the current onboarding chain
public
setChainStep(int $step) : void
Parameters
- $step : int
-
Chain step