Package org.ametys.plugins.forms.actions

Class ProcessFormAction

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.apache.cocoon.acting.AbstractAction

org.apache.cocoon.acting.ServiceableAction

org.ametys.plugins.forms.actions.AbstractProcessFormAction

org.ametys.plugins.forms.actions.ProcessFormAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action

Direct Known Subclasses:

ProcessMiniSurveyAction

public class ProcessFormAction
extends AbstractProcessFormAction

Process the user entries to the form.

Field Summary

Fields

Modifier and Type	Field	Description
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected FormEntryDAO	_formEntryDAO	The form entry DAO
protected FormMailHelper	_formMailHelper	The form mail helper
protected FormWorkflowHelper	_formWorkflowHelper	The form workflow helper
protected LimitedEntriesHelper	_limitedEntriesHelper	the Handle Limited Entries Helper
protected PageHelper	_pageHelper	The page helper
protected ScheduleOpeningHelper	_scheduleOpeningHelper	The schedule opening helper
protected UserManager	_userManager	The users manager
static final String	CAPTCHA_KEY	The catpcha key

Fields inherited from class org.ametys.plugins.forms.actions.AbstractProcessFormAction

_entryDAO, _foAmetysObjectCreationHelper, _formDAO, _formQuestionDAO, _resolver, _rightManager

Fields inherited from class org.apache.cocoon.acting.ServiceableAction

manager

Fields inherited from class org.apache.cocoon.acting.AbstractAction

EMPTY_MAP

Fields inherited from interface org.apache.cocoon.acting.Action

ROLE

Constructor Summary

Constructors

Constructor	Description
ProcessFormAction()

Method Summary

Modifier and Type	Method	Description
protected boolean	_checkCaptcha(Request request, Form form, Multimap<String,I18nizableText> formErrors)	Check the captcha if needed
protected List<FormQuestion>	_getRuleFilteredQuestions(Request request, Form form, FormQuestionDAO.FormEntryValues entryValues, Optional<Long> currentStepId)	Get the list of active question depending of the form rules
protected Map<String,String>	_processForm(Request request)	Process form
protected void	_sendEmails(FormEntry entry)	Send the receipt and notification emails.
protected void	_setEntryId(FormEntry entry)	Set entry id (auto-incremental id)
Map	act(Redirector redirector, SourceResolver resolver, Map objectModel, String source, Parameters parameters)
void	service(ServiceManager serviceManager)

Methods inherited from class org.ametys.plugins.forms.actions.AbstractProcessFormAction

_adaptFormValuesForChoiceList, _getRuleFilteredEntryView, _handleComputedValues

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CAPTCHA_KEY

public static final String CAPTCHA_KEY

The catpcha key

See Also:

• Constant Field Values

_formWorkflowHelper

protected FormWorkflowHelper _formWorkflowHelper

The form workflow helper

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_userManager

protected UserManager _userManager

The users manager

_limitedEntriesHelper

protected LimitedEntriesHelper _limitedEntriesHelper

the Handle Limited Entries Helper

_formMailHelper

protected FormMailHelper _formMailHelper

The form mail helper

_scheduleOpeningHelper

protected ScheduleOpeningHelper _scheduleOpeningHelper

The schedule opening helper

_pageHelper

protected PageHelper _pageHelper

The page helper

_formEntryDAO

protected FormEntryDAO _formEntryDAO

The form entry DAO

Constructor Details

ProcessFormAction

public ProcessFormAction()

Method Details

service

public void service(ServiceManager serviceManager)
             throws ServiceException

Specified by:

service in interface Serviceable

Overrides:

service in class AbstractProcessFormAction

Throws:

ServiceException

act

public Map act(Redirector redirector,
 SourceResolver resolver,
 Map objectModel,
 String source,
 Parameters parameters)
        throws Exception

Throws:

Exception

_getRuleFilteredQuestions

protected List<FormQuestion> _getRuleFilteredQuestions(Request request,
 Form form,
 FormQuestionDAO.FormEntryValues entryValues,
 Optional<Long> currentStepId)

Description copied from class: AbstractProcessFormAction

Get the list of active question depending of the form rules

Specified by:

_getRuleFilteredQuestions in class AbstractProcessFormAction

Parameters:

request - the request

form - the form

entryValues - the entry values to compute rules

currentStepId - the current step id. Can be empty if the form has no workflow

Returns:

the list of active question depending of the form rules

_processForm

protected Map<String,String> _processForm(Request request)

Process form

Parameters:

request - the request

Returns:

the results

_checkCaptcha

protected boolean _checkCaptcha(Request request,
 Form form,
 Multimap<String,I18nizableText> formErrors)

Check the captcha if needed

Parameters:

request - the request

form - the form

formErrors - the form errors

Returns:

true if the captcha is good

_setEntryId

protected void _setEntryId(FormEntry entry)

Set entry id (auto-incremental id)

Parameters:

entry - the entry

_sendEmails

protected void _sendEmails(FormEntry entry)

Send the receipt and notification emails.

Parameters:

entry - the current entry