trait UserForm (View source)

Defines the user defined functionality to be applied to any {@link DataObject}

Traits

Provides extensions to this object to integrate it with standard config API methods.

Properties

static private array $extensions

Built in extensions required by this page.

static private bool $upgrade_on_build

Should this module automatically upgrade on dev/build?

static private bool $block_default_userforms_css

Set this to true to disable automatic inclusion of CSS files

static private bool $block_default_userforms_js

Set this to true to disable automatic inclusion of JavaScript files

static private array $casting
static private string $error_container_id

Error container selector which matches the element for grouped messages

static private bool $enable_are_you_sure

The configuration used to determine whether a confirmation message is to appear when navigating away from a partially completed form.

static private bool $recipients_warning_enabled

Methods

static Config_ForClass
config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

mixed
uninherited(string $name)

Gets the uninherited value for the given config option

populateDefaults()

No description

getCMSFields()

No description

getSubmissionsGridField()

No description

FilteredEmailRecipients($data = null, $form = null)

Allow overriding the EmailRecipients on a {@link DataExtension} so you can customise who receives an email.

getFormOptions()

Custom options for the form. You can extend the built in options by using {@link updateFormOptions()}

string
getErrorContainerID()

Get the HTML id of the error container displayed above the form.

getCMSValidator()

Validate formfields

Details

static Config_ForClass config()

Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .....).

Return Value

Config_ForClass

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

populateDefaults()

FieldList getCMSFields()

Return Value

FieldList

getSubmissionsGridField()

ArrayList FilteredEmailRecipients($data = null, $form = null)

Allow overriding the EmailRecipients on a {@link 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.

Parameters

$data
$form

Return Value

ArrayList

FieldList getFormOptions()

Custom options for the form. You can extend the built in options by using {@link updateFormOptions()}

Return Value

FieldList

string getErrorContainerID()

Get the HTML id of the error container displayed above the form.

Return Value

string

getCMSValidator()

Validate formfields