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

public static 
config()

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

public
mixed
stat(string $name) deprecated

Get inherited config value

public
mixed
uninherited(string $name)

Gets the uninherited value for the given config option

public
$this
set_stat(string $name, mixed $value) deprecated

Update the config value for a given property

public
populateDefaults()

No description

public
getCMSFields()

No description

public
getSubmissionsGridField()

No description

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

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

public
getFormOptions()

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

public
string
getErrorContainerID()

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

public
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 stat(string $name) deprecated

deprecated 5.0 Use ->config()->get() instead

Get inherited config value

Parameters

string $name

Return Value

mixed

mixed uninherited(string $name)

Gets the uninherited value for the given config option

Parameters

string $name

Return Value

mixed

$this set_stat(string $name, mixed $value) deprecated

deprecated 5.0 Use ->config()->set() instead

Update the config value for a given property

Parameters

string $name
mixed $value

Return Value

$this

populateDefaults()

No description

FieldList getCMSFields()

No description

Return Value

FieldList

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.

Parameters

$data
$form

Return Value

ArrayList

FieldList getFormOptions()

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

Return Value

FieldList

string getErrorContainerID()

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

Return Value

string

getCMSValidator()

Validate formfields