CustomHtmlForm\Extensions\CustomHtmlFormExtension
Interface for a DataExtension to decorate a CustomHtmlForm
- Author: Sebastian Diel <sdiel@pixeltricks.de>
- Copyright: 2017 pixeltricks GmbH
- License: see license file in modules root directory
Synopsis
interface CustomHtmlFormExtension
{
- // methods
- public bool extendedProcess()
- public bool onAfterConstruct()
- public bool onAfterCustomHtmlFormSpecialFields()
- public bool onAfterSubmitFailure()
- public bool onAfterSubmitSuccess()
- public bool onBeforeConstruct()
- public bool onBeforeCustomHtmlFormSpecialFields()
- public bool onBeforeSubmit()
- public bool onBeforeSubmitFailure()
- public bool onBeforeSubmitSuccess()
- public void overwriteCustomHtmlFormFieldsByGroup()
- public string overwriteSubmitFailure()
- public string overwriteSubmitSuccess()
- public void updateCustomHtmlFormSpecialFields()
- public bool updateFormFields()
- public bool updatePreferences()
- public void updateSubmittedFormData()
Methods
public
- extendedProcess() — This method will be called instead of a CustomHtmlForms process method
- onAfterConstruct() — This method will be called after CustomHtmlForm's __construct().
- onAfterCustomHtmlFormSpecialFields() — Adds some custom markup to the CustomHtmlFormSpecialFields markup on after the default markup will be added.
- onAfterSubmitFailure() — This method will be called after CustomHtmlForm's default submitFailure.
- onAfterSubmitSuccess() — This method will be called after CustomHtmlForm's default submitSuccess.
- onBeforeConstruct() — This method will be called before CustomHtmlForm's __construct().
- onBeforeCustomHtmlFormSpecialFields() — Adds some custom markup to the CustomHtmlFormSpecialFields markup on before the default markup will be added.
- onBeforeSubmit() — This method will be called before CustomHtmlForm's default submit.
- onBeforeSubmitFailure() — This method will be called before CustomHtmlForm's default submitFailure.
- onBeforeSubmitSuccess() — This method will be called before CustomHtmlForm's default submitSuccess.
- overwriteCustomHtmlFormFieldsByGroup() — Updates form fields by group.
- overwriteSubmitFailure() — This method will replace CustomHtmlForm's default submitFailure. It's important that this method returns sth. to ensure that the default submitFailure won't be called. The return value should be a rendered template or sth. similar.
- overwriteSubmitSuccess() — This method will replace CustomHtmlForm's default submitSuccess. It's important that this method returns sth. to ensure that the default submitSuccess won't be called. The return value should be a rendered template or sth. similar.
- updateCustomHtmlFormSpecialFields() — Updates the special fields.
- updateFormFields() — This method is called before CustomHtmlForm requires the form fields. You can manipulate the default form fields here.
- updatePreferences() — This method is called before CustomHtmlForm set the preferences. You can manipulate the default preferences here.
- updateSubmittedFormData() — Updates the submitted form data.