Interface LaravelUi5\Core\Ui5\Contracts\Ui5ActionInterface

extends Ui5ArtifactInterface

Contract for UI5 Actions.

A UI5 Action represents a state-changing operation that can be invoked from a UI5 client via the generic API dispatcher. Typical examples are:

  • "toggle-lock" on a user
  • "approve-invoice"
  • "discard-draft"

Characteristics:

  • Actions are always mutating operations (never pure reads).
  • Therefore, they must only be exposed as mutating endpoints, e.g. POST, PATCH, etc.
  • Route parameters (IDs, slugs) are declared on the ActionHandler and resolved via {@see ParameterResolverInterface}.
  • Body parameters (form data, payloads) are validated inside the ActionHandler, following Laravel best practices.

Responsibilities:

  • Provide the {@see ActionHandlerInterface} that handles the logic.
Methods
Methods inherited from LaravelUi5\Core\Ui5\Contracts\Ui5ArtifactInterface
getModule(), getNamespace(), getType(), getVersion(), getTitle(), getDescription()