FormAction

Read onlyYes
FinalYes

This is a helper class to understand when FormEngine should be doing something.

Internal

do not use this outside of TYPO3, as this will be cleaned up further at a later stage

Table of Contents

Constants

DOCUMENT_CLOSE_MODE_CLEAR_ALL  = 3

Properties

$isPostRequest  : bool

Methods

createFromRequest()  : FormAction
doSave()  : bool
If true, the processing of incoming data will be performed as if a save-button is pressed.
duplicatedoc()  : bool
Is true when - the incoming data should be persisted - and the data should be used to show a form with the same data in it as a new record
getAbsoluteCloseDocValue()  : int
savedoknew()  : bool
Is true when - the incoming data should be persisted - and a new for of the same type should be shown to create the next entry
savedokview()  : bool
Is true when - the incoming data should be persisted - and the record should be shown in frontend (via new tab)
shouldCloseAfterSave()  : bool
shouldCloseWithARedirect()  : bool
If mode is NOT set (means 0) OR set to 1, then make a header location redirect to $this->retUrl
shouldHandleDocumentClosing()  : bool
shouldProcessData()  : bool

Constants

DOCUMENT_CLOSE_MODE_CLEAR_ALL

public mixed DOCUMENT_CLOSE_MODE_CLEAR_ALL = 3

Properties

Methods

createFromRequest()

public static createFromRequest(ServerRequestInterface $request) : FormAction
Parameters
$request : ServerRequestInterface
Return values
FormAction

doSave()

If true, the processing of incoming data will be performed as if a save-button is pressed.

public doSave() : bool

Used in the forms as a hidden field which can be set through JavaScript if the form is somehow submitted by JavaScript.

Return values
bool

duplicatedoc()

Is true when - the incoming data should be persisted - and the data should be used to show a form with the same data in it as a new record

public duplicatedoc() : bool
Tags
todo:

WHAT HAPPENS IF I EDIT MULTIPLE RECORDS?

Return values
bool

getAbsoluteCloseDocValue()

public getAbsoluteCloseDocValue() : int
Return values
int

savedoknew()

Is true when - the incoming data should be persisted - and a new for of the same type should be shown to create the next entry

public savedoknew() : bool
Tags
todo:

WHAT HAPPENS IF I EDIT MULTIPLE RECORDS?

Return values
bool

savedokview()

Is true when - the incoming data should be persisted - and the record should be shown in frontend (via new tab)

public savedokview() : bool

@todo: WHAT HAPPENS IF I EDIT MULTIPLE RECORDS?

Return values
bool

shouldCloseAfterSave()

public shouldCloseAfterSave() : bool
Return values
bool

shouldCloseWithARedirect()

If mode is NOT set (means 0) OR set to 1, then make a header location redirect to $this->retUrl

public shouldCloseWithARedirect() : bool
Return values
bool

shouldHandleDocumentClosing()

public shouldHandleDocumentClosing() : bool
Return values
bool

shouldProcessData()

public shouldProcessData() : bool
Return values
bool

        
On this page

Search results