class Action extends Action (View source)

Traits

Properties

static protected array $configurations from  Configurable
static protected array $importantConfigurations from  Configurable
protected string $evaluationIdentifier from  EvaluatesClosures
protected array $evaluationParametersToRemove from  EvaluatesClosures
protected string $view
protected array $viewData from  ViewComponent
protected string $viewIdentifier from  BaseAction
static protected array $propertyCache from  ViewComponent
static protected array $methodCache from  ViewComponent
protected bool|Closure $isDisabled from  CanBeDisabled
protected $authorization from  CanBeHidden
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected string|Closure|null $color from  HasColor
protected string|Closure|null $icon from  HasIcon
protected string|Closure|null $iconPosition from  HasIcon
protected Htmlable|Closure|null $label from  HasLabel
protected bool|Closure $isLabelHidden from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected string $name from  HasName
protected string|Closure|null $size from  HasSize
protected array $extraAttributes from  HasExtraAttributes
protected Closure|null $mountUsing from  CanBeMounted
protected Notification|Closure|null $failureNotification from  CanNotify
protected Notification|Closure|null $successNotification from  CanNotify
protected string|Closure|null $failureNotificationTitle from  CanNotify
protected string|Closure|null $successNotificationTitle from  CanNotify
protected array|Closure $extraModalActions from  CanOpenModal
protected bool|Closure|null $isModalCentered from  CanOpenModal
protected bool|Closure $isModalSlideOver from  CanOpenModal
protected array|Closure|null $modalActions from  CanOpenModal
protected Action|Closure|null $modalCancelAction from  CanOpenModal
protected Action|Closure|null $modalSubmitAction from  CanOpenModal
protected string|Closure|null $modalButtonLabel from  CanOpenModal
protected Htmlable|Closure|null $modalContent from  CanOpenModal
protected Htmlable|Closure|null $modalFooter from  CanOpenModal
protected Htmlable|Closure|null $modalHeading from  CanOpenModal
protected Htmlable|Closure|null $modalSubheading from  CanOpenModal
protected string|Closure|null $modalWidth from  CanOpenModal
protected bool|Closure|null $isModalHidden from  CanOpenModal
protected bool|Closure|null $isModalClosedByClickingAway from  CanOpenModal
protected string|Closure|null $failureRedirectUrl from  CanRedirect
protected string|Closure|null $successRedirectUrl from  CanRedirect
protected Closure|string|null $action from  HasAction
protected array $arguments from  HasArguments
protected array $formData from  HasForm
protected array|Closure $formSchema from  HasForm
protected bool|Closure $isFormDisabled from  HasForm
protected Closure|null $mutateFormDataUsing from  HasForm
protected Closure|null $before from  HasLifecycleHooks
protected Closure|null $after from  HasLifecycleHooks
protected Closure|null $beforeFormFilled from  HasLifecycleHooks
protected Closure|null $afterFormFilled from  HasLifecycleHooks
protected Closure|null $beforeFormValidated from  HasLifecycleHooks
protected Closure|null $afterFormValidated from  HasLifecycleHooks
protected bool $isWizard from  HasWizard
protected bool|Closure $isWizardSkippable from  HasWizard
int|Closure $wizardStartStep from  HasWizard
protected Component $component from  BelongsToComponent
protected bool|Closure $shouldOpenUrlInNewTab from  CanOpenUrl
protected string|Closure|null $url from  CanOpenUrl
protected string|Closure|null $tooltip from  HasTooltip

Methods

static 
configureUsing(Closure $callback, Closure|null $during = null, bool $isImportant = false)

No description

configure()

No description

void
setUp()

No description

evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

array
resolveEvaluationParameter(string $parameter, Closure $value)

No description

bool
isEvaluationParameterRemoved(string $parameter)

No description

view(string $view, array $viewData = [])

No description

array
extractPublicProperties()

No description

array
extractPublicMethods()

No description

viewData(array $data)

No description

string
getView()

No description

string
toHtml()

No description

View
render()

No description

disabled(bool|Closure $condition = true)

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

authorize($abilities, Model|array|null $arguments = null)

No description

authorizeAny(string|array $abilities, Model|array|null $arguments = null)

No description

array
parseAuthorizationArguments(array $arguments)

No description

hidden(bool|Closure $condition = true)

No description

visible(bool|Closure $condition = true)

No description

bool
isHidden()

No description

bool
isAuthorized()

No description

color(string|Closure|null $color)

No description

from  HasColor
string|null
getColor()

No description

from  HasColor
icon(string|Closure|null $icon)

No description

from  HasIcon
iconPosition(string|Closure|null $position)

No description

from  HasIcon
string|null
getIcon()

No description

from  HasIcon
string|null
getIconPosition()

No description

from  HasIcon
disableLabel(bool|Closure $condition = true)

No description

from  HasLabel
label(Htmlable|Closure|null $label)

No description

from  HasLabel
translateLabel(bool $shouldTranslateLabel = true)

No description

from  HasLabel
Htmlable|null
getLabel()

No description

from  HasLabel
bool
isLabelHidden()

No description

from  HasLabel
name(string $name)

No description

from  HasName
string
getName()

No description

from  HasName
size(string|Closure|null $size)

No description

from  HasSize
string|null
getSize()

No description

from  HasSize
extraAttributes(array|Closure $attributes, bool $merge = false)

No description

array
getExtraAttributes()

No description

ComponentAttributeBag
getExtraAttributeBag()

No description

__construct(string $name)

No description

static BaseAction
make(string|null $name = null)

No description

static string|null
getDefaultName()

No description

withAttributes(array $attributes) deprecated

No description

mount(array $parameters)

No description

mountUsing(Closure|null $callback)

No description

getMountUsing()

No description

failureNotification(Notification|Closure|null $notification)

No description

failureNotificationMessage(string|Closure|null $message) deprecated

No description

failureNotificationTitle(string|Closure|null $title)

No description

successNotification(Notification|Closure|null $notification)

No description

successNotificationMessage(string|Closure|null $message) deprecated

No description

successNotificationTitle(string|Closure|null $title)

No description

string|null
getSuccessNotificationTitle()

No description

string|null
getFailureNotificationTitle()

No description

closeModalByClickingAway(bool|Closure|null $condition = true)

No description

centerModal(bool|Closure|null $condition = true)

No description

slideOver(bool|Closure $condition = true)

No description

modalActions(array|Closure|null $actions = null)

No description

extraModalActions(array|Closure $actions)

No description

modalSubmitAction(Action|Closure|null $action = null)

No description

modalCancelAction(Action|Closure|null $action = null)

No description

modalButton(string|Closure|null $label = null)

No description

modalContent(Htmlable|Closure|null $content = null)

No description

modalFooter(Htmlable|Closure|null $content = null)

No description

modalHeading(Htmlable|Closure|null $heading = null)

No description

modalSubheading(Htmlable|Closure|null $subheading = null)

No description

modalWidth(string|Closure|null $width = null)

No description

modalHidden(bool|Closure|null $condition = false)

No description

string
getLivewireCallActionName()

No description

array
getModalActions()

No description

array
filterHiddenModalActions(array $actions)

No description

getModalSubmitAction()

No description

getModalCancelAction()

No description

array
getExtraModalActions()

No description

string
getModalButtonLabel()

No description

Htmlable|null
getModalContent()

No description

Htmlable|null
getModalFooter()

No description

Htmlable
getModalHeading()

No description

Htmlable|null
getModalSubheading()

No description

string
getModalWidth()

No description

bool
isModalCentered()

No description

bool
isModalSlideOver()

No description

bool
isModalHidden()

No description

bool
isModalClosedByClickingAway()

No description

bool
shouldOpenModal()

No description

makeExtraModalAction(string $name, array|null $arguments = null)

No description

static string
getModalActionClass()

No description

static Action
makeModalAction(string $name)

No description

void
redirect(string|Closure $url)

No description

failureRedirectUrl(string|Closure|null $url)

No description

successRedirectUrl(string|Closure|null $url)

No description

requiresConfirmation(bool|Closure $condition = true)

No description

action(Closure|string|null $action)

No description

Closure|null
getAction()

No description

arguments(array $arguments)

No description

array
getArguments()

No description

resetArguments()

No description

disableForm(bool|Closure $condition = true)

No description

from  HasForm
form(array|Closure $schema)

No description

from  HasForm
array
getFormSchema()

No description

from  HasForm
bool
hasForm()

No description

from  HasForm
bool
hasFormSchema()

No description

from  HasForm
mutateFormDataUsing(Closure|null $callback)

No description

from  HasForm
formData(array $data, bool $shouldMutate = true)

No description

from  HasForm
resetFormData()

No description

from  HasForm
array
getFormData()

No description

from  HasForm
bool
isFormDisabled()

No description

from  HasForm
before(Closure $callback)

No description

after(Closure $callback)

No description

callBefore()

No description

callAfter()

No description

callBeforeFormFilled()

No description

callAfterFormFilled()

No description

steps(array|Closure $steps)

No description

startOnStep(int|Closure $startStep)

No description

skippableSteps(bool|Closure $condition = true)

No description

bool
isWizard()

No description

bool
isWizardSkippable()

No description

int
getWizardStartStep()

No description

call(array $parameters = [])

No description

from  Action
void
cancel()

No description

from  Action
void
halt()

No description

from  Action
void
hold() deprecated

No description

from  Action
void
success()

No description

from  Action
void
failure()

No description

from  Action
getLivewire()

No description

component(Component $component)

No description

getComponent()

No description

openUrlInNewTab(bool|Closure $condition = true)

No description

url(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

string|null
getUrl()

No description

bool
shouldOpenUrlInNewTab()

No description

tooltip(string|Closure|null $tooltip)

No description

string|null
getTooltip()

No description

iconButton()

No description

Details

static configureUsing(Closure $callback, Closure|null $during = null, bool $isImportant = false)

No description

Parameters

Closure $callback
Closure|null $during
bool $isImportant

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

evaluate($value, array $parameters = [], array $exceptParameters = [])

No description

Parameters

$value
array $parameters
array $exceptParameters

protected array getDefaultEvaluationParameters()

No description

Return Value

array

protected resolveEvaluationParameter(string $parameter, Closure $value)

No description

Parameters

string $parameter
Closure $value

protected bool isEvaluationParameterRemoved(string $parameter)

No description

Parameters

string $parameter

Return Value

bool

ViewComponent view(string $view, array $viewData = [])

No description

Parameters

string $view
array $viewData

Return Value

ViewComponent

protected array extractPublicProperties()

No description

Return Value

array

protected array extractPublicMethods()

No description

Return Value

array

ViewComponent viewData(array $data)

No description

Parameters

array $data

Return Value

ViewComponent

string getView()

No description

Return Value

string

string toHtml()

No description

Return Value

string

View render()

No description

Return Value

View

CanBeDisabled disabled(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeDisabled

bool isDisabled()

No description

Return Value

bool

bool isEnabled()

No description

Return Value

bool

CanBeHidden authorize($abilities, Model|array|null $arguments = null)

No description

Parameters

$abilities
Model|array|null $arguments

Return Value

CanBeHidden

CanBeHidden authorizeAny(string|array $abilities, Model|array|null $arguments = null)

No description

Parameters

string|array $abilities
Model|array|null $arguments

Return Value

CanBeHidden

protected array parseAuthorizationArguments(array $arguments)

No description

Parameters

array $arguments

Return Value

array

CanBeHidden hidden(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

CanBeHidden visible(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeHidden

bool isHidden()

No description

Return Value

bool

bool isAuthorized()

No description

Return Value

bool

HasColor color(string|Closure|null $color)

No description

Parameters

string|Closure|null $color

Return Value

HasColor

string|null getColor()

No description

Return Value

string|null

HasIcon icon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

HasIcon

HasIcon iconPosition(string|Closure|null $position)

No description

Parameters

string|Closure|null $position

Return Value

HasIcon

string|null getIcon()

No description

Return Value

string|null

string|null getIconPosition()

No description

Return Value

string|null

HasLabel disableLabel(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

HasLabel label(Htmlable|Closure|null $label)

No description

Parameters

Htmlable|Closure|null $label

Return Value

HasLabel

HasLabel translateLabel(bool $shouldTranslateLabel = true)

No description

Parameters

bool $shouldTranslateLabel

Return Value

HasLabel

Htmlable|null getLabel()

No description

Return Value

Htmlable|null

bool isLabelHidden()

No description

Return Value

bool

HasName name(string $name)

No description

Parameters

string $name

Return Value

HasName

string getName()

No description

Return Value

string

HasSize size(string|Closure|null $size)

No description

Parameters

string|Closure|null $size

Return Value

HasSize

string|null getSize()

No description

Return Value

string|null

HasExtraAttributes extraAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraAttributes

array getExtraAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraAttributeBag()

No description

Return Value

ComponentAttributeBag

final __construct(string $name)

No description

Parameters

string $name

static BaseAction make(string|null $name = null)

No description

Parameters

string|null $name

Return Value

BaseAction

static string|null getDefaultName()

No description

Return Value

string|null

BaseAction withAttributes(array $attributes) deprecated

deprecated Use `->extraAttributes()` instead.

No description

Parameters

array $attributes

Return Value

BaseAction

mount(array $parameters)

No description

Parameters

array $parameters

CanBeMounted mountUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanBeMounted

Closure getMountUsing()

No description

Return Value

Closure

CanNotify sendFailureNotification()

No description

Return Value

CanNotify

CanNotify failureNotification(Notification|Closure|null $notification)

No description

Parameters

Notification|Closure|null $notification

Return Value

CanNotify

CanNotify failureNotificationMessage(string|Closure|null $message) deprecated

deprecated Use `failureNotificationTitle()` instead.

No description

Parameters

string|Closure|null $message

Return Value

CanNotify

CanNotify failureNotificationTitle(string|Closure|null $title)

No description

Parameters

string|Closure|null $title

Return Value

CanNotify

CanNotify sendSuccessNotification()

No description

Return Value

CanNotify

CanNotify successNotification(Notification|Closure|null $notification)

No description

Parameters

Notification|Closure|null $notification

Return Value

CanNotify

CanNotify successNotificationMessage(string|Closure|null $message) deprecated

deprecated Use `successNotificationTitle()` instead.

No description

Parameters

string|Closure|null $message

Return Value

CanNotify

CanNotify successNotificationTitle(string|Closure|null $title)

No description

Parameters

string|Closure|null $title

Return Value

CanNotify

string|null getSuccessNotificationTitle()

No description

Return Value

string|null

string|null getFailureNotificationTitle()

No description

Return Value

string|null

CanOpenModal closeModalByClickingAway(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

CanOpenModal centerModal(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

CanOpenModal slideOver(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenModal

CanOpenModal modalActions(array|Closure|null $actions = null)

No description

Parameters

array|Closure|null $actions

Return Value

CanOpenModal

CanOpenModal extraModalActions(array|Closure $actions)

No description

Parameters

array|Closure $actions

Return Value

CanOpenModal

CanOpenModal modalSubmitAction(Action|Closure|null $action = null)

No description

Parameters

Action|Closure|null $action

Return Value

CanOpenModal

CanOpenModal modalCancelAction(Action|Closure|null $action = null)

No description

Parameters

Action|Closure|null $action

Return Value

CanOpenModal

CanOpenModal modalButton(string|Closure|null $label = null)

No description

Parameters

string|Closure|null $label

Return Value

CanOpenModal

CanOpenModal modalContent(Htmlable|Closure|null $content = null)

No description

Parameters

Htmlable|Closure|null $content

Return Value

CanOpenModal

CanOpenModal modalFooter(Htmlable|Closure|null $content = null)

No description

Parameters

Htmlable|Closure|null $content

Return Value

CanOpenModal

CanOpenModal modalHeading(Htmlable|Closure|null $heading = null)

No description

Parameters

Htmlable|Closure|null $heading

Return Value

CanOpenModal

CanOpenModal modalSubheading(Htmlable|Closure|null $subheading = null)

No description

Parameters

Htmlable|Closure|null $subheading

Return Value

CanOpenModal

CanOpenModal modalWidth(string|Closure|null $width = null)

No description

Parameters

string|Closure|null $width

Return Value

CanOpenModal

CanOpenModal modalHidden(bool|Closure|null $condition = false)

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

protected string getLivewireCallActionName()

No description

Return Value

string

array getModalActions()

No description

Return Value

array

protected array filterHiddenModalActions(array $actions)

No description

Parameters

array $actions

Return Value

array

Action getModalSubmitAction()

No description

Return Value

Action

Action getModalCancelAction()

No description

Return Value

Action

array getExtraModalActions()

No description

Return Value

array

string getModalButtonLabel()

No description

Return Value

string

Htmlable|null getModalContent()

No description

Return Value

Htmlable|null

Htmlable|null getModalFooter()

No description

Return Value

Htmlable|null

Htmlable getModalHeading()

No description

Return Value

Htmlable

Htmlable|null getModalSubheading()

No description

Return Value

Htmlable|null

string getModalWidth()

No description

Return Value

string

bool isModalCentered()

No description

Return Value

bool

bool isModalSlideOver()

No description

Return Value

bool

bool isModalHidden()

No description

Return Value

bool

bool isModalClosedByClickingAway()

No description

Return Value

bool

bool shouldOpenModal()

No description

Return Value

bool

Action makeExtraModalAction(string $name, array|null $arguments = null)

No description

Parameters

string $name
array|null $arguments

Return Value

Action

static protected string getModalActionClass()

No description

Return Value

string

static Action makeModalAction(string $name)

No description

Parameters

string $name

Return Value

Action

CanRedirect dispatchFailureRedirect()

No description

Return Value

CanRedirect

CanRedirect dispatchSuccessRedirect()

No description

Return Value

CanRedirect

void redirect(string|Closure $url)

No description

Parameters

string|Closure $url

Return Value

void

CanRedirect failureRedirectUrl(string|Closure|null $url)

No description

Parameters

string|Closure|null $url

Return Value

CanRedirect

CanRedirect successRedirectUrl(string|Closure|null $url)

No description

Parameters

string|Closure|null $url

Return Value

CanRedirect

CanRequireConfirmation requiresConfirmation(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanRequireConfirmation

HasAction action(Closure|string|null $action)

No description

Parameters

Closure|string|null $action

Return Value

HasAction

Closure|null getAction()

No description

Return Value

Closure|null

HasArguments arguments(array $arguments)

No description

Parameters

array $arguments

Return Value

HasArguments

array getArguments()

No description

Return Value

array

HasArguments resetArguments()

No description

Return Value

HasArguments

HasForm disableForm(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasForm

HasForm form(array|Closure $schema)

No description

Parameters

array|Closure $schema

Return Value

HasForm

array getFormSchema()

No description

Return Value

array

bool hasForm()

No description

Return Value

bool

bool hasFormSchema()

No description

Return Value

bool

HasForm mutateFormDataUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasForm

HasForm formData(array $data, bool $shouldMutate = true)

No description

Parameters

array $data
bool $shouldMutate

Return Value

HasForm

HasForm resetFormData()

No description

Return Value

HasForm

array getFormData()

No description

Return Value

array

bool isFormDisabled()

No description

Return Value

bool

HasLifecycleHooks before(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks after(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks beforeFormFilled(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks afterFormFilled(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks beforeFormValidated(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks afterFormValidated(Closure $callback)

No description

Parameters

Closure $callback

Return Value

HasLifecycleHooks

callBefore()

No description

callAfter()

No description

callBeforeFormFilled()

No description

callAfterFormFilled()

No description

callBeforeFormValidated()

No description

callAfterFormValidated()

No description

HasWizard steps(array|Closure $steps)

No description

Parameters

array|Closure $steps

Return Value

HasWizard

HasWizard startOnStep(int|Closure $startStep)

No description

Parameters

int|Closure $startStep

Return Value

HasWizard

HasWizard skippableSteps(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasWizard

bool isWizard()

No description

Return Value

bool

bool isWizardSkippable()

No description

Return Value

bool

int getWizardStartStep()

No description

Return Value

int

call(array $parameters = [])

No description

Parameters

array $parameters

void cancel()

No description

Return Value

void

void halt()

No description

Return Value

void

void hold() deprecated

deprecated Use `->halt()` instead.

No description

Return Value

void

void success()

No description

Return Value

void

void failure()

No description

Return Value

void

HasForms getLivewire()

No description

Return Value

HasForms

BelongsToComponent component(Component $component)

No description

Parameters

Component $component

Return Value

BelongsToComponent

Component getComponent()

No description

Return Value

Component

CanOpenUrl openUrlInNewTab(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenUrl

CanOpenUrl url(string|Closure|null $url, bool|Closure $shouldOpenInNewTab = false)

No description

Parameters

string|Closure|null $url
bool|Closure $shouldOpenInNewTab

Return Value

CanOpenUrl

string|null getUrl()

No description

Return Value

string|null

bool shouldOpenUrlInNewTab()

No description

Return Value

bool

HasTooltip tooltip(string|Closure|null $tooltip)

No description

Parameters

string|Closure|null $tooltip

Return Value

HasTooltip

string|null getTooltip()

No description

Return Value

string|null

Action iconButton()

No description

Return Value

Action