offline/oc-forms-plugin

Simple Form Builder Plugin for October CMS

v1.0.40 2024-09-18 09:04 UTC

Requires

• php: >=8.1
• october/rain: >=3.3

Suggests

• mews/captcha: ^3.3
• responsiv/uploader-plugin: ^1.0

MIT

• Tobias Kündig

README

This plugin provides a simple way to create frontend forms.

Installation

Install the plugin using composer:

composer require offline/oc-forms-plugin

Features

• Create forms in the backend
• Display forms on the frontend
• View submissions in the backend
• Send email notifications on form submission
• Export submissions to CSV
• Multisite support
• Optional file uploads using Responsiv.Uploader
• Integrates with OFFLINE.Boxes out-of-the-box.

Usage

In the backend, go to the Forms menu item and create a new form. You can use the renderForm component to display the form on the frontend. All submissions of the form will be visible in the backend.

Components

renderForm

Use the renderForm component to display a form on the frontend.

AJAX framework dependency

The component requires the AJAX framework to be present on the page. You can set the includeFramework property to true to include the framework automatically.

CSS classes

The default form markup comes with a few CSS classes that you can use to style your form.

You can set the cssPrefix property to change the prefix of the CSS classes.

Form classes

Use the formClasses property to add additional CSS classes to the form element.

Honeypot

The form comes with a honeypot field to prevent spam. You can disable this by setting the honeypot property to false.

File uploads

To enable file uploads, you need to install the Responsiv.Uploader plugin:

composer require responsiv/uploader-plugin

After installing the plugin, you can add file upload fields to your form in the backend.

You can use the fileuploadPlaceholderText property to define a custom placeholder text for the upload button.

Important: Responsiv.Uploader depends on jQuery. This means you need to include jQuery on your page. Set the includeJQuery property to true if you want the component to include jQuery automatically.

Captcha Support

To enable captcha support, you need to install the Captcha for Laravel composer package:

composer require mews/captcha

Once the package is installed, you can enable the captcha field in the form settings.

Field overrides

The renderForm component comes with a powerful way to override the default form field partials.

To do so, create a partial with the proper name in your partials directory.

Overrides are process in the following order:

Name overrides

Override a field by its name. To do so, create a partial with the following name:

_name_{fieldName}.htm
# Example: _name_address.htm
# Important: The field name is sluggified. So "Your Name" becomes "your-name".

Type overrides

Override all fields with a given input type. To do so, create a partial with the following name:

_type_{fieldType}.htm
# Example: _type_email.htm

Generic overrides

Take a look at the default partials of the renderForm component. You can override any other partial like the label or the validation message.

OFFLINE.Boxes integration

To make the renderForm component available in Boxes, use the following partial:

form.htm

{% component box.uniqueComponentAlias('renderForm') %}

form.yaml

handle: OFFLINE.Forms::forms
name: 'offline.forms::lang.forms'
section: 'offline.forms::lang.boxes_section'

validation:
    rules:
        form: required

components:
    renderForm:
        uniqueAlias: true
        # properties:
        #   formClasses: 'floating-label'
        #   cssPrefix: 'prefix-'
        #   includeJQuery: true
        #   includeFramework: true

form:
    fields:
        form:
            label: 'offline.forms::lang.form'
            type: dropdown
            span: full
            emptyOption: 'offline.forms::lang.form_empty_option'
            options: '\OFFLINE\Forms\Models\Form::getFormOptions'

Helper methods

prependField and appendField

These two methods allow you to add fields to the form before or after the existing fields.

$form->prependField([
    'name' => 'some-field',
    'label' => 'First field',
    'type' => 'text',
]);

mapFields

Apply a transform to each field in the form. The transform will receive the field as its first argument.

$form->mapFields(function (array $field) {
    if (array_get($field, 'is_required')) {
        $field['label'] .= ' (required)';
    }

    return $field;
});

applyPlaceholderToFields

The Form model provides a simple helper method to apply placeholders to all fields that have no placeholder set. The label property of the field will be used as the placeholder.

This is useful for "floating label" form implementations where each field must have a placeholder.

You can pass in an optional transform function.

$form->applyPlaceholderToFields(function(array $field) {
    if (array_get($field, 'is_required')) {
        $field['placeholder'] .= ' *';
    }

    return $field;
});

Events

offline.forms::form.extend

Use this event to apply changes to the form globally (frontend, backend, export).

Event::listen(
    \OFFLINE\Forms\Classes\Events::FORM_EXTEND,
    function (\OFFLINE\Forms\Models\Form $form, string $context, $widget) {
            if ($context === Contexts::FIELDS) {
                // Form fields are being extended.
                info('$widget is a Backend Form widget');
            } else if ($context === Contexts::COLUMNS) {
                // List columns are being extended.
                info('$widget is a Backend Lists widget');
            } else if ($context === Contexts::COMPONENT) {
                // The form is rendered in the component.
                info('$widget is the RenderForm component');
            } else if ($context === Contexts::MAIL) {
                // The mail for a form submission is being sent.
                info('$widget is null');
            }

            // Add a field for a specific form.
            if ($form->slug === 'my-form') {
                $form->prependField([
                    'name' => 'my-hidden-value',
                    'label' => 'Something additional',
                    'type' => 'hidden',
                    'value' => 'Top secret'
                ]);
            }
    }
);

offline.forms::form.beforeRender

Use this event to change the form before it is rendered.

Event::listen(
    \OFFLINE\Forms\Classes\Events::FORM_BEFORE_RENDER,
    function (\OFFLINE\Forms\Models\Form $form, \OFFLINE\Forms\Components\RenderForm $component) {
        // Do anything with the form or $form->fields here.
        $form->applyPlaceholderToFields();
    }
);