class FormTemplateHelper

A helper class for managing {@link Form} and {@link FormField} HTML template output.

This primarily exists to maintain backwards compatibility between Form and FormField template changes since developers may rely on specific HTML output in their applications. Any core changes to templates (such as changing ID's) may have the potential to silently prevent websites from working.

To provide a form with a custom FormTemplateHelper use the following snippet:

$form->setTemplateHelper('ClassName');

Globally, the FormTemplateHelper can be set via the {@link Injector} API.

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array $args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

string
generateFormID(Form $form)

No description

string
generateFieldHolderID(FormField $field)

No description

string
generateFieldID(FormField $field)

Generate the field ID value

Details

in Injectable at line 26
static Injectable create(array $args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class Optional classname to create, if the called class should not be used

Return Value

Injectable The singleton instance

at line 35
string generateFormID(Form $form)

Parameters

Form $form

Return Value

string

at line 51
string generateFieldHolderID(FormField $field)

Parameters

FormField $field

Return Value

string

at line 62
string generateFieldID(FormField $field)

Generate the field ID value

Parameters

FormField $field

Return Value

string