Configurable quick forms

Problem/Motivation

farmOS provides a framework for developers to build "Quick Forms" which are simplified data entry forms that are targeted at specific use-cases or workflows. Examples of these include the Planting quick form, the Birth quick form, and the Movement quick form. Documentation for quick form development is available at: https://farmos.org/development/module/quick/

In the current implementation, there is no standardized way for quick form developers to provide configuration options that affect the display and behavior of their quick forms.

Proposed resolution

This work will extend farmOS's Quick Forms framework to make it possible for developers to build "Configurable quick forms" in a standardized way. "Configurable quick forms" are quick forms that will have their own configuration options that can be adjusted by the farmOS user to change how the quick form itself works/behaves.

Developers will be able to designate individual quick forms as "configurable", and provide a separate "configuration form" for them, which saves to a new configuration entity type.

A bonus outcome of this work will be that it becomes possible for multiple instances of the same quick form plugin to be created. Each configuration entity will produce one quick form (each with unique configuration), and multiple configuration entities may use the same quick form plugin.

Remaining tasks

• Provide a configuration entity type for quick form instances.
• Provide a ConfigurableQuickFormInterface that quick forms can use to declare themselves configurable.
• Provide a ConfigurableQuickFormTrait that quick forms can use for default methods.
• Provide a QuickFormInstanceManager service class with helper methods for instantiating quick form plugins.
• Allow quick forms to be disabled by disabling their config entities.
• Provide a "default instance" for quick forms that do not have a config entity saved (for backwards compatibility).
• Add a requiresEntity property to quick form plugins to optionally prevent creating default instances.
• Add a configure quick forms permission, granted to managed roles with "config" level access.
• Add a ConfigureQuickForm for building, validating, and submitting configuration forms.
• Save configuration entities when ConfigureQuickForm is submitted.
• Automatically build routes, menu items, and tabs to navigate to configuration forms.
• Refactor route building logic into a single route.
• Provide developer documentation for building configurable quick forms.
• Automated tests.

User interface changes

This will not introduce any UI changes itself, but it will provide configuration forms for future quick forms that are designated as configurable.

API changes

Any saved quick form configuration entities will be available via API.

Data model changes

A new configuration entity for quick form configurations.