| Methods |
protected
|
addStepTitle(View $view, string $step): void
Utility for setting Title for each step.
Utility for setting Title for each step.
|
#
|
protected
|
addFormTo(View $view): Form
Utility for setting form in each step.
Utility for setting form in each step.
|
#
|
protected
|
setFormField(Form $form, array $fields, string $step): Form
Will add field into form based on $fields array.
Will add field into form based on $fields array.
|
#
|
protected
|
runSteps(): void
|
#
|
protected
|
doArgs(View $page): void
|
#
|
protected
|
doFields(View $page): void
|
#
|
protected
|
doPreview(View $page): void
|
#
|
protected
|
doFinal(View $page): void
|
#
|
protected
|
getSteps(): array
Get how many steps is required for this action.
Get how many steps is required for this action.
|
#
|
protected
|
isFirstStep(string $step): bool
|
#
|
protected
|
isLastStep(string $step): bool
|
#
|
protected
|
getPreviousStep(string $step): string
|
#
|
protected
|
getNextStep(string $step): string
|
#
|
protected
|
getStep(): string
|
#
|
protected
|
createButtonBar(): View
|
#
|
protected
|
jsSetButtonsState(View $view, string $step): void
Generate JS for setting Buttons state based on current step.
Generate JS for setting Buttons state based on current step.
|
#
|
protected
|
jsSetNextState(string $step): JsExpressionable
Generate JS for Next button state.
Generate JS for Next button state.
|
#
|
protected
|
jsSetPreviousState(string $step): JsExpressionable
Generated JS for Previous button state.
Generated JS for Previous button state.
|
#
|
protected
|
jsSetExecuteState(string $step): JsExpressionable
Generate JS for Execute button state.
Generate JS for Execute button state.
|
#
|
protected
|
jsSetPreviousHandler(View $view, string $step): void
Generate JS function for Previous button.
Generate JS function for Previous button.
|
#
|
protected
|
jsSetSubmitButton(View $view, Form $form, string $step): void
Determine which button is responsible for submitting form on a specific step.
Determine which button is responsible for submitting form on a specific step.
|
#
|
protected
|
jsStepSubmit(string $step): JsBlock
Get proper JS after submitting a form in a step.
Get proper JS after submitting a form in a step.
|
#
|
protected
|
getActionData(string $step): array
|
#
|
private
|
setActionDataFromModel(string $step, Model $model, array<string> $fields): void
|
#
|
protected
|
getActionPreview(): mixed
Get action preview based on it's argument.
Get action preview based on it's argument.
|
#
|
protected
|
getActionArgs(array $data): array
Utility for retrieving Argument.
Utility for retrieving Argument.
|
#
|
| Properties |
protected
|
array<int, string>
|
$steps
The steps need to complete the action.
The steps need to complete the action.
|
#
|
protected
|
string
|
$step
current step.
|
#
|
protected
|
Loader
|
$loader
The Loader that will execute all action step.
The Loader that will execute all action step.
|
#
|
public
|
string
|
$loaderUi = 'basic segment'
|
#
|
public
|
array
|
$loaderShim = []
|
#
|
protected
|
Button
|
$previousStepButton
The action step previous button.
The action step previous button.
|
#
|
protected
|
Button
|
$nextStepButton
The action next step button.
The action next step button.
|
#
|
protected
|
Button
|
$executeActionButton
The execute action button.
The execute action button.
|
#
|
protected
|
View
|
$buttonsView
|
#
|
public
|
UserAction
|
$action
The action to execute.
|
#
|
private
|
array
|
$actionData = []
will collect data while doing action step.
will collect data while doing action step.
|
#
|
protected
|
bool
|
$actionInitialized = false
|
#
|
public
|
JsExpressionable|Closure
|
$jsSuccess
JS expression to return if action was successful, e.g "new JsToast('Thank you')"
JS expression to return if action was successful, e.g "new JsToast('Thank you')"
|
#
|
public
|
array
|
$formSeed = [Form::class]
A seed for creating form in order to edit arguments/fields user entry.
A seed for creating form in order to edit arguments/fields user entry.
|
#
|
public
|
string
|
$previewType = 'html'
can be "console", "text", or "html". Determine how preview step will display information.
can be "console", "text", or "html". Determine how preview step will display information.
|
#
|
protected
|
array<string, array<mixed>>
|
$stepTitle = ['args' => [], 'fields' => [], 'preview' => []]
View seed for displaying title for each step.
View seed for displaying title for each step.
|
#
|
public
|
string
|
$finalMsg = 'Complete!'
|
#
|