java.lang.Object
- org.ametys.runtime.plugin.component.AbstractLogEnabled
- - org.ametys.plugins.forms.processing.ProcessFormHelper

All Implemented Interfaces:

LogEnabled, Component, Contextualizable, Serviceable
```
public class ProcessFormHelper
extends AbstractLogEnabled
implements Component, Serviceable, Contextualizable
```
Helper that processes the user submitted data on a form.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ProcessFormHelper.FormInformations
Class representing form informations

Field Summary

Fields
Modifier and Type	Field	Description
`protected AmetysObjectResolver`	`_ametysObjectResolver`	The ametys object resolver
`protected Context`	`_context`	The context
`protected CurrentUserProvider`	`_currentUserProvied`	current user provider
`protected static DateFormat`	`_DATE_FORMAT`	The date format pattern.
`protected static Pattern`	`_DATE_PATTERN`	The integer validation pattern.
`protected static DateFormat`	`_DATETIME_FORMAT`	The date and time format pattern.
`protected static Pattern`	`_DATETIME_PATTERN`	The integer validation pattern.
`protected static Pattern`	`_EMAIL_PATTERN`	The email validation pattern.
`protected static Pattern`	`_FLOAT_PATTERN`	The integer validation pattern.
`protected FormPropertiesManager`	`_formPropertiesManager`	Form properties manager.
`protected FormTableManager`	`_formTableManager`	Form table manager.
`protected static Pattern`	`_INT_PATTERN`	The integer validation pattern.
`protected static Pattern`	`_PHONE_PATTERN`	The phone validation pattern.
`protected String`	`_pluginName`	The plugin name.
`protected URIPrefixHandler`	`_prefixHandler`	The URI prefix handler
`protected RightManager`	`_rightManager`	Rights manager
`protected SiteManager`	`_siteManager`	The site manager.
`protected SourceResolver`	`_sourceResolver`	The source resolver.
`protected SQLDatabaseTypeExtensionPoint`	`_sqlDatabaseTypeExtensionPoint`	The SQLDatabaseTypeExtensionPoint instance
`protected static DateFormat`	`_TIME_FORMAT`	The time format pattern.
`protected static Pattern`	`_TIME_PATTERN`	The integer validation pattern.
`protected WorkflowHelper`	`_workflowHelper`	The workflow helper component
`protected WorkflowProvider`	`_workflowProvider`	The workflow provider
`protected static String`	`PARAM_CONTENT_ID`	The content ID parameter.
`static String`	`PARAM_FORM_ID`	The form ID parameter.
`static String`	`ROLE`	The Avalon role

Constructor Summary

Constructors
Constructor Description

ProcessFormHelper()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Collection<FieldValue>`	`_getEntriesToInsert(Collection<FieldValue> entries)`	Retain only the entries that are to be inserted in the database.
`protected FieldValue`	`_getFileEntry(Request request, Field field, String id, String name, FormErrors errors)`	Get a file entry from the request.
`protected Collection<File>`	`_getFiles(Map<String,FieldValue> input)`	Get the files of a user input.
`protected String`	`_getFormRedirection(Form form, String entryId)`	Get the form redirection
`protected Map<String,FieldValue>`	`_getInput(Form form, Request request, FormErrors errors)`	Get the user input.
`protected String`	`_getMail(String resource, Form form, Map<String,FieldValue> input)`	Get a mail pipeline's content.
`protected String`	`_insertInput(Form form, Map<String,FieldValue> input, Map objectModel)`	Insert the user submission in the database.
`protected void`	`_sendEmails(Form form, Map<String,FieldValue> input, Site site, Integer totalSubmissions)`	Send the receipt and notification emails.
`protected void`	`_sendLimitEmail(Form form, Map<String,FieldValue> input, String sender)`	Send the limit email.
`protected void`	`_sendNotificationEmails(Form form, Map<String,FieldValue> input, String sender)`	Send the notification emails.
`protected void`	`_sendReceiptEmail(Form form, Map<String,FieldValue> input, String sender)`	Send the receipt email.
`protected void`	`_setParameters(Form form, Map<String,FieldValue> input, PreparedStatement stmt, String dbType)`	Set the parameters into the prepared statement.
`protected List<I18nizableText>`	`_validateCaptcha(FieldValue entry, Request request)`	Validate a captcha.
`protected List<I18nizableText>`	`_validateCheckbox(FieldValue entry, Request request)`	Validate a checkbox input.
`protected List<I18nizableText>`	`_validateConfirmation(FieldValue entry, Request request, String keyPrefix)`	Validate a confirmation.
`protected List<I18nizableText>`	`_validateFile(FieldValue entry, Request request)`	Validate a file input.
`protected void`	`_validateInput(Form form, Map<String,FieldValue> input, FormErrors errors, Request request)`	Validate the user input.
`protected List<I18nizableText>`	`_validateMandatory(FieldValue entry, String keyPrefix)`	Validate a mandatory field.
`protected List<I18nizableText>`	`_validatePassword(FieldValue entry, Request request)`	Validate a password field.
`protected List<I18nizableText>`	`_validateRadio(FieldValue entry, Request request)`	Validate a radio input.
`protected List<I18nizableText>`	`_validateSelect(FieldValue entry, Request request)`	Validate a select input.
`protected List<I18nizableText>`	`_validateTextarea(FieldValue entry, Request request)`	Validate a textarea.
`protected List<I18nizableText>`	`_validateTextField(FieldValue entry, Request request)`	Validate a text field.
`void`	`contextualize(Context context)`
`ProcessFormHelper.FormInformations`	`processForm(Form form, Site site, String pluginName)`	Process form
`void`	`service(ServiceManager serviceManager)`

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled
getLogger, setLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROLE
```
public static final String ROLE
```
The Avalon role

PARAM_FORM_ID
```
public static final String PARAM_FORM_ID
```
The form ID parameter.

See Also:

Constant Field Values

PARAM_CONTENT_ID
```
protected static final String PARAM_CONTENT_ID
```
The content ID parameter.

See Also:

Constant Field Values