Class Atk4\Data\Model\UserAction

`uses`	`DiContainerTrait, InitializerTrait, TrackableTrait`

Implements generic user action. Assigned to a model it can be invoked by a user. Model\UserAction class contains a meta information about the action (arguments, permissions, appliesTo records, etc) that will help UI/API or add-ons to display action trigger (button) correctly in an automated way.

UserAction must NOT rely on any specific UI implementation.

Located at data/src/Model/UserAction.php

Methods
`private`	`_getOwner(): Model`	#
`public`	`isOwnerEntity(): bool`	#
`public`	`getModel(): Model`	#
`public`	`getEntity(): Model`	#
`public`	`getActionForEntity(Model $entity): static`	#
`public`	`execute(mixed ...$args): mixed` Attempt to execute callback of the action. Attempt to execute callback of the action.	#
`protected`	`validateBeforeExecute(): void`	#
`public`	`preview(mixed ...$args): mixed` Identical to Execute but display a preview of what will happen. Identical to Execute but display a preview of what will happen.	#
`public`	`getDescription(): string` Get description of this current action in a user-understandable language. Get description of this current action in a user-understandable language.	#
`public`	`getConfirmation(): string\|false` Return confirmation message for action. Return confirmation message for action.	#
`public`	`getCaption(): string`	#
`public`	`getOwner(): false` use getModel() or getEntity() method instead use getModel() or getEntity() method instead	#

Methods used from Atk4\Core\DiContainerTrait
`setDefaults(), setMissingProperty(), assertInstanceOf(), _fromSeedPrecheck(), fromSeed(), fromSeedUnsafe()`

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

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

Constants
`public`	`APPLIES_TO_NO_RECORDS = 'none'` Defining records scope of the action Defining records scope of the action	#
`public`	`APPLIES_TO_SINGLE_RECORD = 'single'`	#
`public`	`APPLIES_TO_MULTIPLE_RECORDS = 'multiple'`	#
`public`	`APPLIES_TO_ALL_RECORDS = 'all'`	#
`public`	`MODIFIER_CREATE = 'create'` Defining action modifier Defining action modifier	#
`public`	`MODIFIER_UPDATE = 'update'`	#
`public`	`MODIFIER_DELETE = 'delete'`	#
`public`	`MODIFIER_READ = 'read'`	#

Properties
`public`	`string`	`$appliesTo = self::APPLIES_TO_SINGLE_RECORD` by default action is for a single record by default action is for a single record	#
`public`	`string`	`$modifier` How this action interact with record How this action interact with record	#
`public`	`(Closure(object, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed): mixed)\|string`	`$callback` code to execute. By default will call entity method with same name code to execute. By default will call entity method with same name	#
`public`	`(Closure(object, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed, mixed): mixed)\|string`	`$preview` identical to callback, but would generate preview of action without permanent effect identical to callback, but would generate preview of action without permanent effect	#
`public`	`string\|null`	`$caption` caption to put on the button caption to put on the button	#
`public`	`string\|(Closure($this): string)\|null`	`$description` a longer description of this action. a longer description of this action.	#
`public`	`bool\|string\|(Closure($this): string)`	`$confirmation = false` Will ask user to confirm. Will ask user to confirm.	#
`public`	`bool\|(Closure(object): bool)`	`$enabled = true` setting this to false will disable action. setting this to false will disable action.	#
`public`	`bool`	`$system = false` system action will be hidden from UI, but can still be explicitly triggered system action will be hidden from UI, but can still be explicitly triggered	#
`public`	`array<string, array<string, mixed>\|Model>`	`$args = []` Argument definition. Argument definition.	#
`public`	`array<int, string>\|bool`	`$fields = []` Specify which fields may be dirty when invoking action. APPLIES_TO_NO_RECORDS\|APPLIES_TO_SINGLE_RECORD scopes for… Specify which fields may be dirty when invoking action. APPLIES_TO_NO_RECORDS\|APPLIES_TO_SINGLE_RECORD scopes for adding/modifying	#
`public`	`bool`	`$atomic = true` Atomic action will automatically begin transaction before and commit it after completing. Atomic action will automatically begin transaction before and commit it after completing.	#

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

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

Namespaces

Classes

Traits

Class Atk4\Data\Model\UserAction