class ImportAction extends Action (View source)

Traits

Constants

BADGE_VIEW

BUTTON_VIEW

GROUPED_VIEW

ICON_BUTTON_VIEW

LINK_VIEW

Properties

protected string $evaluationIdentifier from  EvaluatesClosures
static protected Closure>> $macros from  Macroable
protected string $view from  ViewComponent
protected string|Closure|null $defaultView from  ViewComponent
protected array<string,mixed> $viewData from  ViewComponent
protected string $viewIdentifier from  StaticAction
protected ActionGroup|null $group from  BelongsToGroup
protected bool|Closure $isDisabled from  CanBeDisabled
protected mixed $authorization from  CanBeHidden
protected bool|Closure $isHidden from  CanBeHidden
protected bool|Closure $isVisible from  CanBeHidden
protected string|Closure|null $labeledFrom from  CanBeLabeledFrom
protected bool|Closure $isOutlined from  CanBeOutlined
protected string|null $parentActionCallLivewireClickHandler from  CanCallParentAction
protected bool|Closure $shouldClose from  CanClose
protected string|Closure|null $event from  CanDispatchEvent
protected array $eventData from  CanDispatchEvent
protected string|bool $dispatchDirection from  CanDispatchEvent
protected string|null $dispatchToComponent from  CanDispatchEvent
protected bool|Closure $shouldOpenUrlInNewTab from  CanOpenUrl
protected string|Closure|null $url from  CanOpenUrl
protected bool $canSubmitForm from  CanSubmitForm
protected string|null $formToSubmit from  CanSubmitForm
protected string|null $formId from  CanSubmitForm
protected Closure|string|null $action from  HasAction
protected bool|Closure|null $isLivewireClickHandlerEnabled from  HasAction
protected array<string,mixed> $arguments from  HasArguments
protected string|Closure|null $groupedIcon from  HasGroupedIcon
protected string $keyBindings from  HasKeyBindings
protected Htmlable|Closure|null $label from  HasLabel
protected bool|Closure $isLabelHidden from  HasLabel
protected bool $shouldTranslateLabel from  HasLabel
protected string|null $name from  HasName
protected ActionSize|string|Closure|null $defaultSize from  HasSize
protected ActionSize|string|Closure|null $size from  HasSize
protected string|Closure|null $tooltip from  HasTooltip
protected string|int|float|Closure|null $badge from  HasBadge
protected string $badgeColor from  HasBadge
protected string|Closure|null $badgeIcon from  HasBadge
protected IconPosition|string|Closure|null $badgeIconPosition from  HasBadge
protected string $color from  HasColor
protected string $defaultColor from  HasColor
protected array $extraAttributes from  HasExtraAttributes
protected Htmlable|Closure|null $icon from  HasIcon
protected IconPosition|string|Closure|null $iconPosition from  HasIcon
protected IconSize|string|Closure|null $iconSize from  HasIcon
protected string|null $livewireTarget from  StaticAction
protected string|Closure|null $alpineClickHandler from  StaticAction
protected Component $livewire from  BelongsToLivewire
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 StaticAction> $cachedExtraModalFooterActions from  CanOpenModal
protected StaticAction[] $extraModalFooterActions from  CanOpenModal
protected bool|Closure|null $isModalFooterSticky from  CanOpenModal
protected bool|Closure|null $isModalHeaderSticky from  CanOpenModal
protected StaticAction> $cachedModalActions from  CanOpenModal
protected StaticAction[] $modalActions from  CanOpenModal
protected bool|Closure $isModalSlideOver from  CanOpenModal
protected Alignment|string|Closure|null $modalAlignment from  CanOpenModal
protected StaticAction> $cachedModalFooterActions from  CanOpenModal
protected StaticAction[] $modalFooterActions from  CanOpenModal
protected Alignment|string|Closure|null $modalFooterActionsAlignment from  CanOpenModal
protected StaticAction|bool|Closure|null $modalCancelAction from  CanOpenModal
protected string|Closure|null $modalCancelActionLabel from  CanOpenModal
protected StaticAction|bool|Closure|null $modalSubmitAction from  CanOpenModal
protected string|Closure|null $modalSubmitActionLabel from  CanOpenModal
protected Htmlable|Closure|null $modalContent from  CanOpenModal
protected Htmlable|Closure|null $modalContentFooter from  CanOpenModal
protected Htmlable|Closure|null $modalHeading from  CanOpenModal
protected Htmlable|Closure|null $modalDescription from  CanOpenModal
protected MaxWidth|string|Closure|null $modalWidth from  CanOpenModal
protected bool|Closure|null $hasModal from  CanOpenModal
protected bool|Closure|null $isModalHidden from  CanOpenModal
protected bool|Closure|null $hasModalCloseButton from  CanOpenModal
protected bool|Closure|null $isModalClosedByClickingAway from  CanOpenModal
protected bool|Closure|null $isModalClosedByEscaping from  CanOpenModal
protected bool|Closure|null $isModalAutofocused from  CanOpenModal
protected string|Closure|null $modalIcon from  CanOpenModal
protected string $modalIconColor from  CanOpenModal
protected string|Closure|null $failureRedirectUrl from  CanRedirect
protected string|Closure|null $successRedirectUrl from  CanRedirect
protected bool|Closure $hasDatabaseTransactions from  CanUseDatabaseTransactions
protected array $extraModalWindowAttributes from  HasExtraModalWindowAttributes
protected array<string,mixed> $formData from  HasForm
protected Component[] $form from  HasForm
protected bool|Closure $isFormDisabled from  HasForm
protected Closure|null $mutateFormDataUsing from  HasForm
protected Component[] $infolist from  HasInfolist
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|string|Closure|null $cancelParentActions from  HasParentActions
protected bool $isWizard from  HasWizard
protected bool|Closure $isWizardSkippable from  HasWizard
protected int|Closure $wizardStartStep from  HasWizard
protected Closure|null $modifyWizardUsing from  HasWizard
protected Table $table from  BelongsToTable
protected bool|Closure $canAccessSelectedRecords from  CanAccessSelectedRecords
protected bool|Closure $shouldDeselectRecordsAfterCompletion from  CanDeselectRecordsAfterCompletion
protected bool|Closure $shouldFetchSelectedRecords from  CanFetchSelectedRecords
protected Model|Closure|null $record from  InteractsWithRecord
protected string|Closure|null $model from  InteractsWithRecord
protected string|Closure|null $modelLabel from  InteractsWithRecord
protected string|Closure|null $pluralModelLabel from  InteractsWithRecord
protected string|Closure|null $recordTitle from  InteractsWithRecord
protected string|Closure|null $recordTitleAttribute from  InteractsWithRecord
protected Importer> $importer from  CanImportRecords
protected string|null $job from  CanImportRecords
protected int|Closure $chunkSize from  CanImportRecords
protected int|Closure|null $maxRows from  CanImportRecords
protected int|Closure|null $headerOffset from  CanImportRecords
protected string|Closure|null $csvDelimiter from  CanImportRecords
protected array<string,mixed> $options from  CanImportRecords
protected array $fileValidationRules from  CanImportRecords

Methods

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

No description

configure()

No description

void
setUp()

No description

mixed
evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

mixed
resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

array
resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

array
resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

string|null
static void
macro(string $name, callable $macro)

No description

static void
mixin(object $mixin, bool $replace = true)

No description

static void
flushMacros()

No description

static mixed
__callStatic(string $method, array $parameters)

No description

mixed
__call(string $method, array $parameters)

No description

static callable|null
getMacro(string $method)

No description

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

No description

defaultView(string|Closure|null $view)

No description

array
extractPublicMethods()

No description

viewData(array $data)

No description

string
getView()

No description

string|null
getDefaultView()

No description

string
toHtml()

No description

View
render()

No description

group(ActionGroup|null $group)

No description

ActionGroup|null
getGroup()

No description

ActionGroup|null
getRootGroup()

No description

disabled(bool|Closure $condition = true)

No description

bool
isDisabled()

No description

bool
isEnabled()

No description

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

No description

authorizeAny(string|BackedEnum|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
isAuthorized()

No description

bool
isHidden()

No description

bool
isHiddenInGroup()

No description

bool
isVisible()

No description

labeledFrom(string|Closure|null $breakpoint = null)

No description

string|null
getLabeledFromBreakpoint()

No description

outlined(bool|Closure $condition = true)

No description

bool
isOutlined()

No description

callParent(string|null $handler)

No description

close(bool|Closure $condition = true)

No description

from  CanClose
bool
shouldClose()

No description

from  CanClose
dispatch(string|Closure|null $event, array|Closure $data = [])

No description

dispatchSelf(string|Closure|null $event, array|Closure $data = [])

No description

dispatchTo(string $component, string|Closure|null $event, array|Closure $data = [])

No description

emit(string|Closure|null $event, array|Closure $data = []) deprecated

No description

emitSelf(string|Closure|null $event, array|Closure $data = []) deprecated

No description

emitTo(string $component, string|Closure|null $event, array|Closure $data = []) deprecated

No description

string|null
getEvent()

No description

eventData(array|Closure $data)

No description

array
getEventData()

No description

string|bool
getDispatchDirection()

No description

string|null
getDispatchToComponent()

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

submit(string|null $form)

No description

bool
canSubmitForm()

No description

string|null
getFormToSubmit()

No description

formId(string|null $id)

No description

string|null
getFormId()

No description

action(Closure|string|null $action)

No description

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

No description

Closure|null
getActionFunction()

No description

bool
arguments(array|null $arguments)

No description

mergeArguments(array $arguments)

No description

array
getArguments()

No description

resetArguments()

No description

bool
hasArguments()

No description

groupedIcon(string|Closure|null $icon)

No description

string|null
getGroupedIcon()

No description

keyBindings(string|array|Closure|null $bindings)

No description

array|null
getKeyBindings()

No description

disableLabel(bool|Closure $condition = true) deprecated

No description

from  HasLabel
hiddenLabel(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|null $name)

No description

from  HasName
string|null
getName()

No description

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

No description

from  HasSize
size(ActionSize|string|Closure|null $size)

No description

from  HasSize
ActionSize|string|null
getDefaultSize()

No description

from  HasSize
ActionSize|string|null
getSize()

No description

from  HasSize
tooltip(string|Closure|null $tooltip)

No description

string|null
getTooltip()

No description

badge(string|int|float|Closure|null $badge = null)

No description

from  HasBadge
indicator(string|int|float|Closure|null $indicator) deprecated

No description

from  HasBadge
badgeColor(string|array|Closure|null $color)

No description

from  HasBadge
badgeIcon(string|Closure|null $icon)

No description

from  HasBadge
badgeIconPosition(IconPosition|string|Closure|null $position)

No description

from  HasBadge
indicatorColor(string|array|Closure|null $color) deprecated

No description

from  HasBadge
string|int|float|null
getBadge()

No description

from  HasBadge
string|array|null
getBadgeColor()

No description

from  HasBadge
string|null
getBadgeIcon()

No description

from  HasBadge
IconPosition|string
getBadgeIconPosition()

No description

from  HasBadge
color(string|array|Closure|null $color)

No description

from  HasColor
defaultColor(string|array|Closure|null $color)

No description

from  HasColor
string|array|null
getColor()

No description

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

No description

array
getExtraAttributes()

No description

ComponentAttributeBag
getExtraAttributeBag()

No description

icon(Htmlable|Closure|null $icon)

No description

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

No description

from  HasIcon
iconSize(IconSize|string|Closure|null $size)

No description

from  HasIcon
Htmlable|null
getIcon()

No description

from  HasIcon
IconPosition|string
getIconPosition()

No description

from  HasIcon
IconSize|string|null
getIconSize()

No description

from  HasIcon
__construct(string|null $name)

No description

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

No description

bool
isBadge()

No description

button()

No description

bool
isButton()

No description

grouped()

No description

iconButton()

No description

bool
isIconButton()

No description

link()

No description

bool
isLink()

No description

alpineClickHandler(string|Closure|null $handler)

No description

static string|null
getDefaultName()

No description

string|null
getLivewireClickHandler()

No description

from  Action
string|null
getLivewireEventClickHandler()

No description

string|null
getAlpineClickHandler()

No description

from  Action
livewireTarget(string|null $target)

No description

string|null
getLivewireTarget()

No description

from  Action
withAttributes(array $attributes) deprecated

No description

livewire(Component $livewire)

No description

object
getLivewire()

No description

mixed
mount(array $parameters)

No description

mountUsing(Closure|null $callback)

No description

fillForm(array|Closure $data)

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

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

No description

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

No description

modalAlignment(Alignment|string|Closure|null $alignment = null)

No description

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

No description

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

No description

modalIcon(string|Closure|null $icon = null)

No description

modalIconColor(string|array|Closure|null $color = null)

No description

slideOver(bool|Closure $condition = true)

No description

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

No description

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

No description

modalFooterActionsAlignment(Alignment|string|Closure|null $alignment = null)

No description

extraModalActions(array|Closure $actions) deprecated

No description

extraModalFooterActions(array|Closure $actions)

No description

registerModalActions(array $actions)

No description

modalSubmitAction(StaticAction|bool|Closure|null $action = null)

No description

modalCancelAction(StaticAction|bool|Closure|null $action = null)

No description

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

No description

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

No description

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

No description

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

No description

modalFooter(Htmlable|Closure|null $footer = null) deprecated

No description

modalContentFooter(Htmlable|Closure|null $footer = null)

No description

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

No description

modalDescription(Htmlable|Closure|null $description = null)

No description

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

No description

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

No description

string|null
modal(bool|Closure|null $condition = true)

No description

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

No description

array
getModalFooterActions()

No description

Alignment|null
array
getModalActions()

No description

StaticAction|null
getModalAction(string $name)

No description

MountableAction|null
getMountableModalAction(string $name)

No description

array
getVisibleModalFooterActions()

No description

StaticAction|null
getModalSubmitAction()

No description

StaticAction|null
getModalCancelAction()

No description

array
getExtraModalFooterActions()

No description

Alignment|string
getModalAlignment()

No description

string
getModalSubmitActionLabel()

No description

string
getModalCancelActionLabel()

No description

Htmlable|null
getModalContent()

No description

Htmlable|null
getModalContentFooter()

No description

bool
hasModalContent()

No description

bool
hasModalContentFooter()

No description

Htmlable|null
getCustomModalHeading()

No description

Htmlable
getModalHeading()

No description

bool
hasCustomModalHeading()

No description

Htmlable|null
getModalDescription()

No description

bool
hasModalDescription()

No description

MaxWidth|string
getModalWidth()

No description

bool
isModalFooterSticky()

No description

bool
isModalHeaderSticky()

No description

bool
isModalSlideOver()

No description

bool
shouldOpenModal(Closure|null $checkForFormUsing = null)

No description

bool
hasModalCloseButton()

No description

bool
isModalClosedByClickingAway()

No description

bool
isModalClosedByEscaping()

No description

bool
isModalAutofocused()

No description

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

No description

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

No description

makeModalAction(string $name)

No description

string|null
getModalIcon()

No description

string|array|null
getModalIconColor()

No description

stickyModalFooter(bool|Closure $condition = true)

No description

stickyModalHeader(bool|Closure $condition = true)

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

databaseTransaction(bool|Closure $condition = true)

No description

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

No description

ComponentAttributeBag
disableForm(bool|Closure $condition = true) deprecated

No description

from  HasForm
disabledForm(bool|Closure $condition = true)

No description

from  HasForm
form(array|Closure|null $form)

No description

from  HasForm
Form|null
getForm(Form $form)

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
infolist(array|Closure|null $infolist)

No description

Infolist|null
getInfolist()

No description

string|null
getInfolistName()

No description

before(Closure|null $callback)

No description

after(Closure|null $callback)

No description

beforeFormFilled(Closure|null $callback)

No description

afterFormFilled(Closure|null $callback)

No description

beforeFormValidated(Closure|null $callback)

No description

afterFormValidated(Closure|null $callback)

No description

mixed
callBefore()

No description

mixed
callAfter()

No description

mixed
callBeforeFormFilled()

No description

mixed
callAfterFormFilled()

No description

mixed
callBeforeFormValidated()

No description

mixed
callAfterFormValidated()

No description

cancelParentActions(bool|string|Closure|null $toAction = true)

No description

bool
shouldCancelAllParentActions()

No description

string|null
getParentActionToCancelTo()

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

modifyWizardUsing(Closure|null $callback)

No description

int
getWizardStartStep()

No description

mixed
call(array $parameters = [])

No description

from  Action
void
cancel(bool $shouldRollBackDatabaseTransaction = false)

No description

void
halt(bool $shouldRollBackDatabaseTransaction = false)

No description

void
hold() deprecated

No description

void
success()

No description

void
failure()

No description

table(Table $table)

No description

getTable()

No description

accessSelectedRecords(bool|Closure $condition = true)

No description

Collection
getSelectedRecords()

No description

fetchSelectedRecords(bool|Closure $condition = true)

No description

__invoke(array $arguments)

No description

record(Model|Closure|null $record)

No description

model(string|Closure|null $model)

No description

modelLabel(string|Closure|null $label)

No description

pluralModelLabel(string|Closure|null $label)

No description

recordTitle(string|Closure|null $title)

No description

recordTitleAttribute(string|Closure|null $attribute)

No description

Model|null
getRecord()

No description

string|null
getRecordTitle(Model|null $record = null)

No description

string|null
getCustomRecordTitle(Model|null $record = null)

No description

string|null
bool
hasCustomRecordTitle()

No description

bool
hasRecord()

No description

string|null
getModel()

No description

string|null
getCustomModel()

No description

string|null
getModelLabel()

No description

string|null
getCustomModelLabel()

No description

string|null
getPluralModelLabel()

No description

string|null
getCustomPluralModelLabel()

No description

string
generateJavaScriptClickHandler(string $method)

No description

from  Action
string|null
getRecordTitleAttribute()

No description

from  Action
resource
getUploadedFileStream(TemporaryUploadedFile $file)

No description

string|null
detectCsvEncoding(mixed $resource)

No description

importer(string $importer)

No description

job(string|null $job)

No description

chunkSize(int|Closure $size)

No description

maxRows(int|Closure|null $rows)

No description

headerOffset(int|Closure|null $offset)

No description

csvDelimiter(string|Closure|null $delimiter)

No description

string
getImporter()

No description

string
getJob()

No description

int
getChunkSize()

No description

int|null
getMaxRows()

No description

int|null
getHeaderOffset()

No description

string|null
getCsvDelimiter(Reader|null $reader = null)

No description

string|null
guessCsvDelimiter(Reader|null $reader = null)

No description

options(array|Closure $options)

No description

array
getOptions()

No description

fileRules(string|array|Closure $rules)

No description

array
getFileValidationRules()

No description

Details

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

No description

Parameters

Closure $modifyUsing
Closure|null $during
bool $isImportant

Return Value

mixed

Configurable configure()

No description

Return Value

Configurable

protected void setUp()

No description

Return Value

void

mixed evaluate(mixed $value, array $namedInjections = [], array $typedInjections = [])

No description

Parameters

mixed $value
array $namedInjections
array $typedInjections

Return Value

mixed

protected mixed resolveClosureDependencyForEvaluation(ReflectionParameter $parameter, array $namedInjections, array $typedInjections)

No description

Parameters

ReflectionParameter $parameter
array $namedInjections
array $typedInjections

Return Value

mixed

protected array resolveDefaultClosureDependencyForEvaluationByName(string $parameterName)

No description

Parameters

string $parameterName

Return Value

array

protected array resolveDefaultClosureDependencyForEvaluationByType(string $parameterType)

No description

Parameters

string $parameterType

Return Value

array

protected string|null getTypedReflectionParameterClassName(ReflectionParameter $parameter)

No description

Parameters

ReflectionParameter $parameter

Return Value

string|null

static void macro(string $name, callable $macro)

No description

Parameters

string $name
callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

static void flushMacros()

No description

Return Value

void

static mixed __callStatic(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

mixed __call(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static protected callable|null getMacro(string $method)

No description

Parameters

string $method

Return Value

callable|null

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

No description

Parameters

string|null $view
array $viewData

Return Value

ViewComponent

ViewComponent defaultView(string|Closure|null $view)

No description

Parameters

string|Closure|null $view

Return Value

ViewComponent

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|null getDefaultView()

No description

Return Value

string|null

string toHtml()

No description

Return Value

string

View render()

No description

Return Value

View

BelongsToGroup group(ActionGroup|null $group)

No description

Parameters

ActionGroup|null $group

Return Value

BelongsToGroup

ActionGroup|null getGroup()

No description

Return Value

ActionGroup|null

ActionGroup|null getRootGroup()

No description

Return Value

ActionGroup|null

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(mixed $abilities, Model|string|array|null $arguments = null)

No description

Parameters

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

Return Value

CanBeHidden

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

No description

Parameters

string|BackedEnum|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 isAuthorized()

No description

Return Value

bool

bool isHidden()

No description

Return Value

bool

bool isHiddenInGroup()

No description

Return Value

bool

bool isVisible()

No description

Return Value

bool

CanBeLabeledFrom labeledFrom(string|Closure|null $breakpoint = null)

No description

Parameters

string|Closure|null $breakpoint

Return Value

CanBeLabeledFrom

string|null getLabeledFromBreakpoint()

No description

Return Value

string|null

CanBeOutlined outlined(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanBeOutlined

bool isOutlined()

No description

Return Value

bool

CanCallParentAction callParent(string|null $handler)

No description

Parameters

string|null $handler

Return Value

CanCallParentAction

string|null getParentActionCallLivewireClickHandler()

No description

Return Value

string|null

CanClose close(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanClose

bool shouldClose()

No description

Return Value

bool

CanDispatchEvent dispatch(string|Closure|null $event, array|Closure $data = [])

No description

Parameters

string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

CanDispatchEvent dispatchSelf(string|Closure|null $event, array|Closure $data = [])

No description

Parameters

string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

CanDispatchEvent dispatchTo(string $component, string|Closure|null $event, array|Closure $data = [])

No description

Parameters

string $component
string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

CanDispatchEvent emit(string|Closure|null $event, array|Closure $data = []) deprecated

deprecated Use `dispatch()` instead.

No description

Parameters

string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

CanDispatchEvent emitSelf(string|Closure|null $event, array|Closure $data = []) deprecated

deprecated Use `dispatchSelf()` instead.

No description

Parameters

string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

CanDispatchEvent emitTo(string $component, string|Closure|null $event, array|Closure $data = []) deprecated

deprecated Use `dispatchTo()` instead.

No description

Parameters

string $component
string|Closure|null $event
array|Closure $data

Return Value

CanDispatchEvent

string|null getEvent()

No description

Return Value

string|null

CanDispatchEvent eventData(array|Closure $data)

No description

Parameters

array|Closure $data

Return Value

CanDispatchEvent

array getEventData()

No description

Return Value

array

string|bool getDispatchDirection()

No description

Return Value

string|bool

string|null getDispatchToComponent()

No description

Return Value

string|null

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

CanSubmitForm submit(string|null $form)

No description

Parameters

string|null $form

Return Value

CanSubmitForm

bool canSubmitForm()

No description

Return Value

bool

string|null getFormToSubmit()

No description

Return Value

string|null

CanSubmitForm formId(string|null $id)

No description

Parameters

string|null $id

Return Value

CanSubmitForm

string|null getFormId()

No description

Return Value

string|null

HasAction action(Closure|string|null $action)

No description

Parameters

Closure|string|null $action

Return Value

HasAction

HasAction livewireClickHandlerEnabled(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

HasAction

Closure|null getActionFunction()

No description

Return Value

Closure|null

bool isLivewireClickHandlerEnabled()

No description

Return Value

bool

HasArguments arguments(array|null $arguments)

No description

Parameters

array|null $arguments

Return Value

HasArguments

HasArguments mergeArguments(array $arguments)

No description

Parameters

array $arguments

Return Value

HasArguments

array getArguments()

No description

Return Value

array

HasArguments resetArguments()

No description

Return Value

HasArguments

bool hasArguments()

No description

Return Value

bool

HasGroupedIcon groupedIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

HasGroupedIcon

string|null getGroupedIcon()

No description

Return Value

string|null

HasKeyBindings keyBindings(string|array|Closure|null $bindings)

No description

Parameters

string|array|Closure|null $bindings

Return Value

HasKeyBindings

array|null getKeyBindings()

No description

Return Value

array|null

| null

HasLabel disableLabel(bool|Closure $condition = true) deprecated

deprecated Use `hiddenLabel()` instead.

No description

Parameters

bool|Closure $condition

Return Value

HasLabel

HasLabel hiddenLabel(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|null $name)

No description

Parameters

string|null $name

Return Value

HasName

string|null getName()

No description

Return Value

string|null

HasSize defaultSize(ActionSize|string|Closure|null $size)

No description

Parameters

ActionSize|string|Closure|null $size

Return Value

HasSize

HasSize size(ActionSize|string|Closure|null $size)

No description

Parameters

ActionSize|string|Closure|null $size

Return Value

HasSize

ActionSize|string|null getDefaultSize()

No description

Return Value

ActionSize|string|null

ActionSize|string|null getSize()

No description

Return Value

ActionSize|string|null

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

HasBadge badge(string|int|float|Closure|null $badge = null)

No description

Parameters

string|int|float|Closure|null $badge

Return Value

HasBadge

HasBadge indicator(string|int|float|Closure|null $indicator) deprecated

deprecated Use `badge()` instead.

No description

Parameters

string|int|float|Closure|null $indicator

Return Value

HasBadge

HasBadge badgeColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

HasBadge

HasBadge badgeIcon(string|Closure|null $icon)

No description

Parameters

string|Closure|null $icon

Return Value

HasBadge

HasBadge badgeIconPosition(IconPosition|string|Closure|null $position)

No description

Parameters

IconPosition|string|Closure|null $position

Return Value

HasBadge

HasBadge indicatorColor(string|array|Closure|null $color) deprecated

deprecated Use `badgeColor()` instead.

No description

Parameters

string|array|Closure|null $color

Return Value

HasBadge

string|int|float|null getBadge()

No description

Return Value

string|int|float|null

string|array|null getBadgeColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

string|null getBadgeIcon()

No description

Return Value

string|null

IconPosition|string getBadgeIconPosition()

No description

Return Value

IconPosition|string

HasColor color(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

HasColor

HasColor defaultColor(string|array|Closure|null $color)

No description

Parameters

string|array|Closure|null $color

Return Value

HasColor

string|array|null getColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: 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

HasIcon icon(Htmlable|Closure|null $icon)

No description

Parameters

Htmlable|Closure|null $icon

Return Value

HasIcon

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

No description

Parameters

IconPosition|string|Closure|null $position

Return Value

HasIcon

HasIcon iconSize(IconSize|string|Closure|null $size)

No description

Parameters

IconSize|string|Closure|null $size

Return Value

HasIcon

Htmlable|null getIcon()

No description

Return Value

Htmlable|null

IconPosition|string getIconPosition()

No description

Return Value

IconPosition|string

IconSize|string|null getIconSize()

No description

Return Value

IconSize|string|null

final __construct(string|null $name)

No description

Parameters

string|null $name

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

No description

Parameters

string|null $name

Return Value

StaticAction

bool isBadge()

No description

Return Value

bool

StaticAction button()

No description

Return Value

StaticAction

bool isButton()

No description

Return Value

bool

Groupable grouped()

No description

Return Value

Groupable

StaticAction iconButton()

No description

Return Value

StaticAction

bool isIconButton()

No description

Return Value

bool

No description

Return Value

StaticAction

No description

Return Value

bool

StaticAction alpineClickHandler(string|Closure|null $handler)

No description

Parameters

string|Closure|null $handler

Return Value

StaticAction

static string|null getDefaultName()

No description

Return Value

string|null

string|null getLivewireClickHandler()

No description

Return Value

string|null

string|null getLivewireEventClickHandler()

No description

Return Value

string|null

string|null getAlpineClickHandler()

No description

Return Value

string|null

StaticAction livewireTarget(string|null $target)

No description

Parameters

string|null $target

Return Value

StaticAction

string|null getLivewireTarget()

No description

Return Value

string|null

StaticAction withAttributes(array $attributes) deprecated

deprecated Use `extraAttributes()` instead.

No description

Parameters

array $attributes

Return Value

StaticAction

BelongsToLivewire livewire(Component $livewire)

No description

Parameters

Component $livewire

Return Value

BelongsToLivewire

object getLivewire()

No description

Return Value

object

mixed mount(array $parameters)

No description

Parameters

array $parameters

Return Value

mixed

CanBeMounted mountUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

CanBeMounted

CanBeMounted fillForm(array|Closure $data)

No description

Parameters

array|Closure $data

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 closeModalByEscaping(bool|Closure|null $condition = true)

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

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

deprecated Use `modalAlignment(Alignment::Center)` instead.

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

CanOpenModal modalAlignment(Alignment|string|Closure|null $alignment = null)

No description

Parameters

Alignment|string|Closure|null $alignment

Return Value

CanOpenModal

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

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

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

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

CanOpenModal modalIcon(string|Closure|null $icon = null)

No description

Parameters

string|Closure|null $icon

Return Value

CanOpenModal

CanOpenModal modalIconColor(string|array|Closure|null $color = null)

No description

Parameters

string|array|Closure|null $color

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) deprecated

deprecated Use `modalFooterActions()` instead.

No description

Parameters

array|Closure|null $actions

Return Value

CanOpenModal

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

No description

Parameters

array|Closure|null $actions

Return Value

CanOpenModal

CanOpenModal modalFooterActionsAlignment(Alignment|string|Closure|null $alignment = null)

No description

Parameters

Alignment|string|Closure|null $alignment

Return Value

CanOpenModal

CanOpenModal extraModalActions(array|Closure $actions) deprecated

deprecated Use `extraModalFooterActions()` instead.

No description

Parameters

array|Closure $actions

Return Value

CanOpenModal

CanOpenModal extraModalFooterActions(array|Closure $actions)

No description

Parameters

array|Closure $actions

Return Value

CanOpenModal

CanOpenModal registerModalActions(array $actions)

No description

Parameters

array $actions

Return Value

CanOpenModal

CanOpenModal modalSubmitAction(StaticAction|bool|Closure|null $action = null)

No description

Parameters

StaticAction|bool|Closure|null $action

Return Value

CanOpenModal

CanOpenModal modalCancelAction(StaticAction|bool|Closure|null $action = null)

No description

Parameters

StaticAction|bool|Closure|null $action

Return Value

CanOpenModal

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

No description

Parameters

string|Closure|null $label

Return Value

CanOpenModal

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

No description

Parameters

string|Closure|null $label

Return Value

CanOpenModal

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

deprecated Use `modalSubmitActionLabel()` instead.

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 $footer = null) deprecated

deprecated Use `modalContentFooter()` instead.

No description

Parameters

Htmlable|Closure|null $footer

Return Value

CanOpenModal

CanOpenModal modalContentFooter(Htmlable|Closure|null $footer = null)

No description

Parameters

Htmlable|Closure|null $footer

Return Value

CanOpenModal

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

No description

Parameters

Htmlable|Closure|null $heading

Return Value

CanOpenModal

CanOpenModal modalDescription(Htmlable|Closure|null $description = null)

No description

Parameters

Htmlable|Closure|null $description

Return Value

CanOpenModal

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

deprecated Use `modalDescription()` instead.

No description

Parameters

Htmlable|Closure|null $subheading

Return Value

CanOpenModal

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

No description

Parameters

MaxWidth|string|Closure|null $width

Return Value

CanOpenModal

string|null getLivewireCallMountedActionName()

No description

Return Value

string|null

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

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

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

No description

Parameters

bool|Closure|null $condition

Return Value

CanOpenModal

array getModalFooterActions()

No description

Return Value

array

Alignment|null getModalFooterActionsAlignment()

No description

Return Value

Alignment|null

array getModalActions()

No description

Return Value

array

StaticAction|null getModalAction(string $name)

No description

Parameters

string $name

Return Value

StaticAction|null

MountableAction|null getMountableModalAction(string $name)

No description

Parameters

string $name

Return Value

MountableAction|null

StaticAction prepareModalAction(StaticAction $action)

No description

Parameters

StaticAction $action

Return Value

StaticAction

array getVisibleModalFooterActions()

No description

Return Value

array

StaticAction|null getModalSubmitAction()

No description

Return Value

StaticAction|null

StaticAction|null getModalCancelAction()

No description

Return Value

StaticAction|null

array getExtraModalFooterActions()

No description

Return Value

array

Alignment|string getModalAlignment()

No description

Return Value

Alignment|string

string getModalSubmitActionLabel()

No description

Return Value

string

string getModalCancelActionLabel()

No description

Return Value

string

Htmlable|null getModalContent()

No description

Return Value

Htmlable|null

Htmlable|null getModalContentFooter()

No description

Return Value

Htmlable|null

bool hasModalContent()

No description

Return Value

bool

bool hasModalContentFooter()

No description

Return Value

bool

Htmlable|null getCustomModalHeading()

No description

Return Value

Htmlable|null

Htmlable getModalHeading()

No description

Return Value

Htmlable

bool hasCustomModalHeading()

No description

Return Value

bool

Htmlable|null getModalDescription()

No description

Return Value

Htmlable|null

bool hasModalDescription()

No description

Return Value

bool

MaxWidth|string getModalWidth()

No description

Return Value

MaxWidth|string

bool isModalFooterSticky()

No description

Return Value

bool

bool isModalHeaderSticky()

No description

Return Value

bool

bool isModalSlideOver()

No description

Return Value

bool

bool shouldOpenModal(Closure|null $checkForFormUsing = null)

No description

Parameters

Closure|null $checkForFormUsing

Return Value

bool

bool hasModalCloseButton()

No description

Return Value

bool

bool isModalClosedByClickingAway()

No description

Return Value

bool

bool isModalClosedByEscaping()

No description

Return Value

bool

bool isModalAutofocused()

No description

Return Value

bool

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

deprecated Use `makeModalSubmitAction()` instead.

No description

Parameters

string $name
array|null $arguments

Return Value

StaticAction

StaticAction makeModalSubmitAction(string $name, array|null $arguments = null)

No description

Parameters

string $name
array|null $arguments

Return Value

StaticAction

StaticAction makeModalAction(string $name)

No description

Parameters

string $name

Return Value

StaticAction

string|null getModalIcon()

No description

Return Value

string|null

string|array|null getModalIconColor()

No description

Return Value

string|array|null

| array{50: string, 100: string, 200: string, 300: string, 400: string, 500: string, 600: string, 700: string, 800: string, 900: string, 950: string} | null

CanOpenModal stickyModalFooter(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenModal

CanOpenModal stickyModalHeader(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanOpenModal

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

CanUseDatabaseTransactions databaseTransaction(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanUseDatabaseTransactions

bool hasDatabaseTransactions()

No description

Return Value

bool

void beginDatabaseTransaction()

No description

Return Value

void

void commitDatabaseTransaction()

No description

Return Value

void

void rollBackDatabaseTransaction()

No description

Return Value

void

HasExtraModalWindowAttributes extraModalWindowAttributes(array|Closure $attributes, bool $merge = false)

No description

Parameters

array|Closure $attributes
bool $merge

Return Value

HasExtraModalWindowAttributes

array getExtraModalWindowAttributes()

No description

Return Value

array

ComponentAttributeBag getExtraModalWindowAttributeBag()

No description

Return Value

ComponentAttributeBag

HasForm disableForm(bool|Closure $condition = true) deprecated

deprecated Use `disabledForm() instead.

No description

Parameters

bool|Closure $condition

Return Value

HasForm

HasForm disabledForm(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

HasForm

HasForm form(array|Closure|null $form)

No description

Parameters

array|Closure|null $form

Return Value

HasForm

Form|null getForm(Form $form)

No description

Parameters

Form $form

Return Value

Form|null

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

HasInfolist infolist(array|Closure|null $infolist)

No description

Parameters

array|Closure|null $infolist

Return Value

HasInfolist

Infolist|null getInfolist()

No description

Return Value

Infolist|null

string|null getInfolistName()

No description

Return Value

string|null

HasLifecycleHooks before(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks after(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks beforeFormFilled(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks afterFormFilled(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks beforeFormValidated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

HasLifecycleHooks afterFormValidated(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasLifecycleHooks

mixed callBefore()

No description

Return Value

mixed

mixed callAfter()

No description

Return Value

mixed

mixed callBeforeFormFilled()

No description

Return Value

mixed

mixed callAfterFormFilled()

No description

Return Value

mixed

mixed callBeforeFormValidated()

No description

Return Value

mixed

mixed callAfterFormValidated()

No description

Return Value

mixed

HasParentActions cancelParentActions(bool|string|Closure|null $toAction = true)

No description

Parameters

bool|string|Closure|null $toAction

Return Value

HasParentActions

bool shouldCancelAllParentActions()

No description

Return Value

bool

string|null getParentActionToCancelTo()

No description

Return Value

string|null

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

HasWizard modifyWizardUsing(Closure|null $callback)

No description

Parameters

Closure|null $callback

Return Value

HasWizard

int getWizardStartStep()

No description

Return Value

int

mixed call(array $parameters = [])

No description

Parameters

array $parameters

Return Value

mixed

void cancel(bool $shouldRollBackDatabaseTransaction = false)

No description

Parameters

bool $shouldRollBackDatabaseTransaction

Return Value

void

void halt(bool $shouldRollBackDatabaseTransaction = false)

No description

Parameters

bool $shouldRollBackDatabaseTransaction

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

BelongsToTable table(Table $table)

No description

Parameters

Table $table

Return Value

BelongsToTable

Table getTable()

No description

Return Value

Table

CanAccessSelectedRecords accessSelectedRecords(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanAccessSelectedRecords

bool canAccessSelectedRecords()

No description

Return Value

bool

Collection getSelectedRecords()

No description

Return Value

Collection

CanDeselectRecordsAfterCompletion deselectRecordsAfterCompletion(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanDeselectRecordsAfterCompletion

bool shouldDeselectRecordsAfterCompletion()

No description

Return Value

bool

CanFetchSelectedRecords fetchSelectedRecords(bool|Closure $condition = true)

No description

Parameters

bool|Closure $condition

Return Value

CanFetchSelectedRecords

bool shouldFetchSelectedRecords()

No description

Return Value

bool

HasMountableArguments __invoke(array $arguments)

No description

Parameters

array $arguments

Return Value

HasMountableArguments

InteractsWithRecord record(Model|Closure|null $record)

No description

Parameters

Model|Closure|null $record

Return Value

InteractsWithRecord

InteractsWithRecord model(string|Closure|null $model)

No description

Parameters

string|Closure|null $model

Return Value

InteractsWithRecord

InteractsWithRecord modelLabel(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

InteractsWithRecord

InteractsWithRecord pluralModelLabel(string|Closure|null $label)

No description

Parameters

string|Closure|null $label

Return Value

InteractsWithRecord

InteractsWithRecord recordTitle(string|Closure|null $title)

No description

Parameters

string|Closure|null $title

Return Value

InteractsWithRecord

InteractsWithRecord recordTitleAttribute(string|Closure|null $attribute)

No description

Parameters

string|Closure|null $attribute

Return Value

InteractsWithRecord

Model|null getRecord()

No description

Return Value

Model|null

string|null getRecordTitle(Model|null $record = null)

No description

Parameters

Model|null $record

Return Value

string|null

string|null getCustomRecordTitle(Model|null $record = null)

No description

Parameters

Model|null $record

Return Value

string|null

string|null getCustomRecordTitleAttribute()

No description

Return Value

string|null

bool hasCustomRecordTitle()

No description

Return Value

bool

bool hasCustomRecordTitleAttribute()

No description

Return Value

bool

bool hasRecord()

No description

Return Value

bool

string|null getModel()

No description

Return Value

string|null

string|null getCustomModel()

No description

Return Value

string|null

string|null getModelLabel()

No description

Return Value

string|null

string|null getCustomModelLabel()

No description

Return Value

string|null

string|null getPluralModelLabel()

No description

Return Value

string|null

string|null getCustomPluralModelLabel()

No description

Return Value

string|null

protected string generateJavaScriptClickHandler(string $method)

No description

Parameters

string $method

Return Value

string

string|null getRecordTitleAttribute()

No description

Return Value

string|null

resource getUploadedFileStream(TemporaryUploadedFile $file)

No description

Parameters

TemporaryUploadedFile $file

Return Value

resource

| false

protected string|null detectCsvEncoding(mixed $resource)

No description

Parameters

mixed $resource

Return Value

string|null

CanImportRecords importer(string $importer)

No description

Parameters

string $importer

Return Value

CanImportRecords

CanImportRecords job(string|null $job)

No description

Parameters

string|null $job

Return Value

CanImportRecords

CanImportRecords chunkSize(int|Closure $size)

No description

Parameters

int|Closure $size

Return Value

CanImportRecords

CanImportRecords maxRows(int|Closure|null $rows)

No description

Parameters

int|Closure|null $rows

Return Value

CanImportRecords

CanImportRecords headerOffset(int|Closure|null $offset)

No description

Parameters

int|Closure|null $offset

Return Value

CanImportRecords

CanImportRecords csvDelimiter(string|Closure|null $delimiter)

No description

Parameters

string|Closure|null $delimiter

Return Value

CanImportRecords

string getImporter()

No description

Return Value

string

string getJob()

No description

Return Value

string

int getChunkSize()

No description

Return Value

int

int|null getMaxRows()

No description

Return Value

int|null

int|null getHeaderOffset()

No description

Return Value

int|null

string|null getCsvDelimiter(Reader|null $reader = null)

No description

Parameters

Reader|null $reader

Return Value

string|null

protected string|null guessCsvDelimiter(Reader|null $reader = null)

No description

Parameters

Reader|null $reader

Return Value

string|null

CanImportRecords options(array|Closure $options)

No description

Parameters

array|Closure $options

Return Value

CanImportRecords

array getOptions()

No description

Return Value

array

CanImportRecords fileRules(string|array|Closure $rules)

No description

Parameters

string|array|Closure $rules

Return Value

CanImportRecords

array getFileValidationRules()

No description

Return Value

array