OnboardingSteps
class OnboardingSteps
Onboarding step definition This contains all the logic for creating, and accessing onboarding steps.
Traits
Singleton trait.
Properties
| static protected | $instance | from Singleton | |
| static private array | $callbacks | ||
| private array | $steps |
Methods
No description
No description
Returns a list of registered onboarding steps.
Determine if all onboarding is complete.
Determine if the onboarding is still in progress.
Get the next incomplete onboarding step, or null if all steps are completed.
No description
No description
Registers the onboarding steps.
Manually registers onboarding steps.
Details
in
Singleton at line 18
final static
instance()
Create a new instance of this singleton.
in
Singleton at line 28
final static
forgetInstance()
Forget this singleton's instance if it exists
in
Singleton at line 36
final protected
__construct()
Constructor.
in
Singleton at line 44
protected
initialize()
Initialize the singleton free from constructor parameters.
in
Singleton at line 48
__clone()
No description
in
Singleton at line 53
__wakeup()
No description
at line 26
getStep($code)
No description
at line 34
removeStep($code)
No description
at line 44
array
listSteps()
Returns a list of registered onboarding steps.
at line 57
bool
completed()
Determine if all onboarding is complete.
at line 69
bool
inProgress()
Determine if the onboarding is still in progress.
at line 79
null|stdClass
nextIncompleteStep()
Get the next incomplete onboarding step, or null if all steps are completed.
at line 86
protected
stepIsCompleted($callable)
No description
at line 95
protected
loadSteps()
No description
at line 130
registerSteps(array $definitions)
Registers the onboarding steps.
The argument is an array of the onboarding steps definition.
at line 166
static
registerCallback(callable $callback)
Manually registers onboarding steps.
Usage:
Onboarding::registerCallback(function($manager){
$manager->registerSteps([...]);
});