README

Define you custom form fields in your created CustomFormPage with this straight forward syntax:

    {{ FieldName | My Field: | Dropdown | { "Option1": "Foo", "Option2": "Bar" } }}
    {{ FieldName * | My Required Field: | Textarea }}
    {{ Captcha |  | Recaptcha }}

You can use as many form fields as you like.

Requirements

SilverStripe 4+

Arguments

The following arguments are listed separated by | in each {{ }} form field block (sequence of arguments is not arbitrary):

Name: String as CamelCase describing the name of your field; e.g.: Email, FirstName … * the field is required, if ends with *; e.g.: Email *
Title: String as title, can contain every character except the | seperator; e.g. Your eMail:
Class of Field: Can be every existing field class, without the Field appendix; e.g.: Text, Textarea, Email, Dropdown …
(assoc.) Array as option for the field * optional * must be JSON * required for DropDownField for instance

Usage in Templates

You can access the form via $CustomForm:

  <% with $MyCustomFormPage %>
    <h1>$Title</h1>
    $CustomForm
  <% end_with %>

Comments and HTML tags

You can use comments # and using html tags. HTML tags will be converted to SilverStripe LiteralFields:

    # My advanced Poll Form Desctiption
    {{ Email * | Your eMail (required): | Email }}
    <hr />
    <h2>Additional Information</h2>
    # Description of something
    {{ Age | Your age: | Dropdown | { "Under20": "younger or just 20", "Over20": "older than 20" } }}

Exclude Fields in form submission

You can explicitly prevent fields to be written in the submission. Just define them in your config:

CustomFormPageSubmission:
  excludeParameters:
    - Foo
    - Bar

Template variables

You can check $FormWasSuccessfullySended and $FormWasSubmitted in your template.

pstaender / silverstripe-customformpage

Maintainers

Details