UserForm
trait UserForm mixin UserFormFieldEditorExtension (View source)
Defines the user defined functionality to be applied to any DataObject
Traits
Provides extensions to this object to integrate it with standard config API methods.
Config options
| extensions | array | Built in extensions required by this page. |
|
| required_identifier | string | ||
| email_template_directory | string | ||
| upgrade_on_build | bool | Should this module automatically upgrade on dev/build? |
|
| block_default_userforms_css | bool | Set this to true to disable automatic inclusion of CSS files |
|
| block_default_userforms_js | bool | Set this to true to disable automatic inclusion of JavaScript files |
|
| db | array | ||
| defaults | array | ||
| has_many | array | ||
| cascade_deletes | |||
| cascade_duplicates | |||
| casting | array | ||
| error_container_id | string | Error container selector which matches the element for grouped messages |
|
| enable_are_you_sure | bool | The configuration used to determine whether a confirmation message is to appear when navigating away from a partially completed form. |
|
| recipients_warning_enabled | bool | ||
| non_live_permissions |
Properties
| protected | array | $fieldsFromTo | Temporary storage of field ids when the form is duplicated. |
Methods
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
Gets the uninherited value for the given config option
Allow overriding the EmailRecipients on a DataExtension so you can customise who receives an email.
Custom options for the form. You can extend the built in options by using updateFormOptions()
Get the HTML id of the error container displayed above the form.
Details
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).
mixed
stat(string $name)
deprecated
deprecated
Get inherited config value
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
$this
set_stat(string $name, mixed $value)
deprecated
deprecated
Update the config value for a given property
populateDefaults()
No description
FieldList
getCMSFields()
No description
getSubmissionsGridField()
No description
ArrayList
FilteredEmailRecipients($data = null, $form = null)
Allow overriding the EmailRecipients on a DataExtension so you can customise who receives an email.
Converts the RelationList to an ArrayList so that manipulation of the original source data isn't possible.
FieldList
getFormOptions()
Custom options for the form. You can extend the built in options by using updateFormOptions()
string
getErrorContainerID()
Get the HTML id of the error container displayed above the form.
getCMSValidator()
Validate formfields