FormAction

final readonly class \TYPO3\CMS\Backend\Form\FormAction

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

Table of Contents

Constants

DOCUMENT_CLOSE_MODE_CLEAR_ALL  : int = 3

Properties

$isPostRequest  : bool

Methods

createFromRequest()  : FormAction
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
savedokaddrecord()  : bool
Is true when - the incoming data should be persisted - and, once saved, the browser should continue on to the "add new related record" wizard (fieldControl.addRecord) for a field that belongs to the record just saved. Used when that record was itself still new (a "NEW..." placeholder uid) when "+" was clicked.
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 int DOCUMENT_CLOSE_MODE_CLEAR_ALL = 3

Properties

Methods

createFromRequest()

public static createFromRequest(ServerRequestInterface $request) : FormAction

Parameters

$request : ServerRequestInterface

Return values

FormAction

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

savedokaddrecord()

Is true when - the incoming data should be persisted - and, once saved, the browser should continue on to the "add new related record" wizard (fieldControl.addRecord) for a field that belongs to the record just saved. Used when that record was itself still new (a "NEW..." placeholder uid) when "+" was clicked.

public savedokaddrecord() : bool

Return values

bool

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