FormHandlerBase (open)
Syntax
LOADLIB "mod::publisher/lib/forms/components.whlib";
OBJECTTYPE FormHandlerBase
Constructor
Properties
- PROPERTY form
- PROPERTY settings
The handler settings, containing the handler node attributes and settings from the handler's parser function
Functions
- STRING FUNCTION DetermineNewSubmissionStatus(RECORD result, OBJECT formresults)
The new submission status (eg "duplicate", "confirm", "pending") when landing on the confirmation page
- RECORD ARRAY FUNCTION GetConfirmationFormSubmitTypes()
- STRING FUNCTION GetFormEditTitle()
Get the title for use in the form editor
- BOOLEAN FUNCTION IsCancelHandler()
- BOOLEAN FUNCTION IsConfirmationHandler()
- BOOLEAN FUNCTION IsRerunnable()
Return if this handler can be re-run on existing results
- BOOLEAN FUNCTION IsSubmitHandler()
- BOOLEAN FUNCTION IsTestableForResults()
Return if this handler can be tested at result-level
- MACRO PrepareForFrontend()
Prepare for use with the frontend (rendering, rpc or validation) (WebHare >= 4.34.1)
- MACRO PrepareRendering()
Prefill form fields
- MACRO PrepareResultData()
Prepare result data
- MACRO PrepareSubmit(OBJECT work)
Hook into submission. No errors yet and any store results handler has already run
- MACRO RunConfirmationUpdates(RECORD formresult)
Invoked before we show a confirm, pending or duplicate page
- MACRO RunTestResult(OBJECT parent, RECORD result, RECORD options)
Actually run the test
- RECORD FUNCTION UpdateResultAfterSubmit(RECORD result)
Postprocess result after successful submissions
- RECORD FUNCTION UpdateResultPendingSubmit(RECORD result)
Postprocess result after handling a pending submissions (confirmation handlers)
- MACRO ValidateForm(OBJECT work)
Validate form results
- MACRO ValidateFormFile(OBJECT work, OBJECT curform, OBJECT contexts)
Validate the form file before saving it (invoked by editor)