class FormActionHelper extends CollectionActionHelper

Use this action for form actions based on a single model

Traits

Constants

FEEDBACK_SUCCESS

FEEDBACK_ERROR

FEEDBACK_NOTE

FEEDBACK_WARNING

Methods

string
__toString()

No description

static ActionHelper
create(string $key, string $title)

Create Action

static ActionHelper
createFromOption(Option $actionOption)

No description

bool
execute()

No description

expects(string $collectionClass)

Which type of collection is expected?

Collection|null
getCollection()

No description

I18nTokenHelper|null
getConfirmationQuestion()

No description

I18nTokenHelper|null
getFeedbackMessage(string|null $feedbackType)

No description

getForm()

No description

bool
getIsDownload()

No description

getOption()

No description

array
jsonSerialize()

Transforms the array structure of this option into a JSON string.

onExecuteCallback(callable $invokeFn)

No description

onExecuteInvoke(string $invokeMethod)

No description

setCollection(Collection $collection)

Pass the collection for the actions to be based upon.

setConfirmationQuestion(I18nTokenHelper|null $confirmationText = null)

No description

setFeedbackMessage(I18nTokenHelper $feedbackMessage, string $feedbackType = self::FEEDBACK_SUCCESS)

No description

setForm(Form $form)

No description

setIsDownload(bool $isDownload)

No description

array
toArray()

No description

when(ConditionGroup $condition)

Conditions can only be applied to Collections which are scopable

Details

in ActionHelper at line 115
string __toString()

No description

Return Value

string

in ActionHelper at line 41
static ActionHelper create(string $key, string $title)

Create Action

Parameters

string $key
string $title

Return Value

ActionHelper

in ActionHelper at line 51
static ActionHelper createFromOption(Option $actionOption)

No description

Parameters

Option $actionOption

Return Value

ActionHelper

at line 20
bool execute()

No description

Return Value

bool

Exceptions

ContentException

CollectionActionHelper expects(string $collectionClass)

Which type of collection is expected?

Parameters

string $collectionClass

Return Value

CollectionActionHelper

Collection|null getCollection()

No description

Return Value

Collection|null

in ActionHelper at line 64
I18nTokenHelper|null getConfirmationQuestion()

No description

Return Value

I18nTokenHelper|null

in ActionHelper at line 73
I18nTokenHelper|null getFeedbackMessage(string|null $feedbackType)

No description

Parameters

string|null $feedbackType

Return Value

I18nTokenHelper|null

at line 68
Form getForm()

No description

Return Value

Form

in ActionHelper at line 83
bool getIsDownload()

No description

Return Value

bool

in ActionHelper at line 122
Option getOption()

No description

Return Value

Option

in ItemTrait at line 13
array jsonSerialize()

Transforms the array structure of this option into a JSON string.

Return Value

array

in ActionHelper at line 105
ActionHelper onExecuteCallback(callable $invokeFn)

No description

Parameters

callable $invokeFn

(Actionhelper $actionHelper)

Return Value

ActionHelper

CollectionActionHelper onExecuteInvoke(string $invokeMethod)

No description

Parameters

string $invokeMethod

Return Value

CollectionActionHelper

CollectionActionHelper setCollection(Collection $collection)

Pass the collection for the actions to be based upon.

The collection will be cloned, further modifications and filters to the original object are not considered

Parameters

Collection $collection

Return Value

CollectionActionHelper

in ActionHelper at line 59
ActionHelper setConfirmationQuestion(I18nTokenHelper|null $confirmationText = null)

No description

Parameters

I18nTokenHelper|null $confirmationText

Return Value

ActionHelper

in ActionHelper at line 68
ActionHelper setFeedbackMessage(I18nTokenHelper $feedbackMessage, string $feedbackType = self::FEEDBACK_SUCCESS)

No description

Parameters

I18nTokenHelper $feedbackMessage
string $feedbackType

Return Value

ActionHelper

at line 60
FormActionHelper setForm(Form $form)

No description

Parameters

Form $form

Return Value

FormActionHelper

in ActionHelper at line 78
ActionHelper setIsDownload(bool $isDownload)

No description

Parameters

bool $isDownload

Return Value

ActionHelper

in ActionHelper at line 111
array toArray()

No description

Return Value

array

CollectionActionHelper when(ConditionGroup $condition)

Conditions can only be applied to Collections which are scopable

Parameters

ConditionGroup $condition

Return Value

CollectionActionHelper