Forms Plugins/Hooks

This page describes the Plugins and hooks offered by the module Hooks.

For general information on plugins, see Plugins.

Plugins

BPC Forms Plugin

This plugin can be used to create a BPC Forms within a Hook

The form to be displayed can either reference an existing BPC Forms component (moduleId), a form from the repository (formId) or an external Form configuration (formUrl). It is also possible to store a valid Form configuration (formConfig) directly in the plugin.

The following settings can be made via the Plugin configuration

moduleId: References an existing BPC Forms component via its ID.
Cannot be combined with formUrl, formConfig or formId.
formUrl: References an external source for a Form configuration. The URL must be accessible for the end user. Please note any requirements regarding CORS.
Cannot be combined with moduleId, formConfig or formId.
formConfig: A valid Form configuration can be stored directly here in JSON format.
Cannot be combined with moduleId, formUrl or formId.
formId: References a form that is stored in the internal forms repository via its repository ID. In addition, a dedicated version can be referenced via formVersion. If formVersion is not given, the latest version is always used.
Cannot be combined with moduleId, formUrl or formConfig.
formVersion: Used to reference a dedicated version of a form in the forms repository. Can only be used in conjunction with formId.
debug: If this parameter is set to true, the debug view of Renderer is activated.
initialData: Form data can be defined at this point. The data is used to define the data area of the form Data area of the form initialized.

Possible parameters for a plugin configuration

{
    "moduleId": null,
    "formUrl"     : null,
    "formConfig"  : null,
    "formId"      : null,
    "formVersion" : null,
    "debug"       : false,
    "initialData" : null
}

Hooks

This module does not offer any hooks Hooks

Keywords: