Class Atk4\Ui\UserAction\VpExecutor

`extends`	`View`
`implements`	`JsExecutorInterface`
`uses`	`CommonExecutorTrait, HookTrait, StepExecutorTrait`

A Step Action Executor that use a VirtualPage.

Atk4\Ui\AbstractView uses AppScopeTrait, ContainerTrait, InitializerTrait, NameTrait, StaticAddToTrait, TrackableTrait
- Atk4\Ui\View
  - Atk4\Ui\UserAction\VpExecutor implements JsExecutorInterface uses CommonExecutorTrait, HookTrait, StepExecutorTrait

Located at ui/src/UserAction/VpExecutor.php

Methods
`protected`	`init(): void` Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Called when view becomes part of render tree. You can override it but avoid placing any "heavy processing" here. Overrides `Atk4\Ui\View::init()`	#
`protected`	`initExecutor(): void`	#
`public`	`getAction(): UserAction` Implements `Atk4\Ui\UserAction\ExecutorInterface::getAction()`	#
`protected`	`afterActionInit(): void` Make sure modal id is unique. Since User action can be added via callbacks, we need to make sure that view id is… Make sure modal id is unique. Since User action can be added via callbacks, we need to make sure that view id is properly set for loader and button JS action to run properly.	#
`public`	`setAction(UserAction $action)` Will associate executor with the action. Will associate executor with the action. Implements `Atk4\Ui\UserAction\ExecutorInterface::setAction()`	#
`public`	`jsExecute(array $urlArgs = []): JsBlock` Return JS expression that will trigger action executor. Return JS expression that will trigger action executor. Implements `Atk4\Ui\UserAction\JsExecutorInterface::jsExecute()`	#
`public`	`executeModelAction(): void` Perform model action by stepping through args - fields - preview. Perform model action by stepping through args - fields - preview. Implements `Atk4\Ui\UserAction\ExecutorInterface::executeModelAction()`	#
`protected`	`addStepList(): void`	#
`protected`	`jsSetListState(View $view, string $currentStep): void`	#
`protected`	`jsGetExecute(mixed $obj, string\|int $id): JsBlock` Return proper JS statement need after action execution. Return proper JS statement need after action execution.	#

Methods inherited from Atk4\Ui\View
__construct(), setModel(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), set(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), renderView(), recursiveRender(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\View

__construct(), setModel(), setSource(), setMissingProperty(), setElement(), link(), getExecutorFactory(), add(), getClosestOwner(), set(), addClass(), removeClass(), setStyle(), removeStyle(), setAttr(), removeAttr(), url(), jsUrl(), _getStickyArgs(), stickyGet(), renderView(), recursiveRender(), renderAll(), renderTemplateToHtml(), render(), renderToTab(), renderToJsonArr(), getHtml(), js(), vue(), jsEmitEvent(), jsGetStoreData(), jsClearStoreData(), jsAddStoreData(), jsReload(), on(), getHtmlId(), getJsRenderActions(), getJs()

Methods inherited from Atk4\Ui\AbstractView
`getOwner()`

Methods used from Atk4\Core\AppScopeTrait
`assertInstanceOfApp(), issetApp(), getApp(), setApp()`

Methods used from Atk4\Core\ContainerTrait
`_uniqueElementName(), _addContainer(), removeElement(), _shorten(), getElement(), hasElement()`

Methods used from Atk4\Core\InitializerTrait
`isInitialized(), assertIsInitialized(), invokeInit()`

Methods used from Atk4\Core\StaticAddToTrait
`_addToAdd(), addTo(), addToWithCl(), addToWithClUnsafe()`

Methods used from Atk4\Core\TrackableTrait
`issetOwner(), setOwner(), unsetOwner(), getDesiredName(), destroy()`

Methods used from Atk4\Ui\UserAction\CommonExecutorTrait
`executeModelActionLoad()`

Methods used from Atk4\Core\HookTrait
`_rebindHookFxToFakeInstance(), _unbindHookFxIfBoundToThis(), _rebindHooksIfCloned(), onHook(), onHookShort(), _makeHookDynamicFx(), onHookDynamic(), onHookDynamicShort(), hookHasCallbacks(), removeHook(), hook(), breakHook()`

Methods used from Atk4\Ui\UserAction\StepExecutorTrait
`addStepTitle(), addFormTo(), setFormField(), runSteps(), doArgs(), doFields(), doPreview(), doFinal(), getSteps(), isFirstStep(), isLastStep(), getPreviousStep(), getNextStep(), getStep(), createButtonBar(), jsSetButtonsState(), jsSetNextState(), jsSetPreviousState(), jsSetExecuteState(), jsSetPreviousHandler(), jsSetSubmitButton(), jsStepSubmit(), getActionData(), setActionDataFromModel(), getActionPreview(), getActionArgs()`

Methods used from Atk4\Ui\UserAction\StepExecutorTrait

addStepTitle(), addFormTo(), setFormField(), runSteps(), doArgs(), doFields(), doPreview(), doFinal(), getSteps(), isFirstStep(), isLastStep(), getPreviousStep(), getNextStep(), getStep(), createButtonBar(), jsSetButtonsState(), jsSetNextState(), jsSetPreviousState(), jsSetExecuteState(), jsSetPreviousHandler(), jsSetSubmitButton(), jsStepSubmit(), getActionData(), setActionDataFromModel(), getActionPreview(), getActionArgs()

Constants
`public`	`HOOK_STEP = self::class . '@onStep'`	#

Properties
`protected`	`VirtualPage`	`$vp`	#
`public`	`string\|null`	`$title`	#
`public`	`Header`	`$header`	#
`public`	`View`	`$stepList`	#
`public`	`array<string, string>`	`$stepListItems = [ 'args' => 'Fill argument(s)', 'fields' => 'Edit Record(s)', 'preview' => 'Preview', 'final' => 'Complete', ]`	#
`public`	`array`	`$cancelButtonSeed = [Button::class, ['Cancel', 'class.small left floated basic blue' => true, 'icon' => 'left arrow']]`	#

Properties inherited from Atk4\Ui\View
`$_jsActions, $model, $region, $ui, $class, $style, $attr, $template, $defaultTemplate, $content, $element, $executorFactory, $stickyArgs`

Properties inherited from Atk4\Ui\AbstractView
`$_addLater, $_rendered, $elements`

Properties used from Atk4\Core\AppScopeTrait
`$_app, $maxNameLength, $uniqueNameHashes`

Properties used from Atk4\Core\ContainerTrait
`$_elementNameCounts`

Properties used from Atk4\Core\InitializerTrait
`$_initialized`

Properties used from Atk4\Core\NameTrait
`$name`

Properties used from Atk4\Core\TrackableTrait
`$_owner, $shortName`

Properties used from Atk4\Core\HookTrait
`$hooks, $_hookIndexCounter, $_hookOrigThis`

Properties used from Atk4\Ui\UserAction\StepExecutorTrait
`$steps, $step, $loader, $loaderUi, $loaderShim, $previousStepButton, $nextStepButton, $executeActionButton, $buttonsView, $action, $actionData, $actionInitialized, $jsSuccess, $formSeed, $previewType, $stepTitle, $finalMsg`

Namespaces

Classes

Interfaces

Traits

Class Atk4\Ui\UserAction\VpExecutor

Overrides

Implements

Implements

Implements

Implements