class UserDefinedForm extends Page (View source)

Traits

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

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.

from  UserForm
static private bool $upgrade_on_build

Should this module automatically upgrade on dev/build?

from  UserForm
static private bool $block_default_userforms_css

Set this to true to disable automatic inclusion of CSS files

from  UserForm
static private bool $block_default_userforms_js

Set this to true to disable automatic inclusion of JavaScript files

from  UserForm
static private array $casting from  UserForm
static private string $error_container_id

Error container selector which matches the element for grouped messages

from  UserForm
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.

from  UserForm
static private bool $recipients_warning_enabled from  UserForm

Methods

static Config_ForClass
config()

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

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

Update the config value for a given property

populateDefaults()

No description

from  UserForm
getCMSFields()

No description

from  UserForm
getSubmissionsGridField()

No description

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

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

from  UserForm
getFormOptions()

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

from  UserForm
string
getErrorContainerID()

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

from  UserForm
getCMSValidator()

Validate formfields

from  UserForm

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()

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