Object Channel

Use the object channel to generate or enrich DataObjects.

Configuration

There are two different resolver strategies you can rely on.

I. Create new Object

If you want to create a new object after each form submission, use this one. You need to choose a data class afterward.

You're able to map fields and field collections.

Options

Name	Description
Object Storage Path	Define where all the objects should be stored.
Object Class	Choose, which data object type should be created.

II. Use existing Object

If you want to append data to a existing object after each form submission, use this one. You need to define an object reference afterwards.

Attention: You're able to map field collections only!

Options

Name	Description
Referencing Object	Define where all the objects should be stored.
Dynamic Object Resolver	If any resolver has been registered, you could choose one. Read more about the dynamic object resolver below.

---

Available Mapping Data

This table shows all possible data mapping fields:

FormBuilder Type	Allowed OpenDxp Type
Text	Text/Input, Text/Textarea, Text/Wysiwyg, CRM/Firstname, CRM/Lastname, CRM/Email
Hidden	Text/Input, Text/Textarea, Text/Wysiwyg, Relation/Many-to-One-Relation, Relation/Many-to-Many-Relation
Text Area	Text/Textarea, Text/Wysiwyg
Integer	Text/Input, Text/Textarea, Text/Wysiwyg, Number/Number, Number/Slider, Relation/Many-to-One-Relation, Relation/Many-to-Many-Relation
Checkbox	Other/Checkbox, CRM/NewsletterActive, CRM/NewsletterConfirmed, CRM/Consent
Date	Date/Date
Date Time	Date/DateTime
Time	Date/Time
Birthday	Date/Date
Choice	Text/Input,Select/Select, Select/MultiSelect, CRM/Gender, Relation/Many-to-One-Relation, Relation/Many-to-Many-Relation
Dynamic Choice	Text/Input,Select/Select, Select/MultiSelect, CRM/Gender, Relation/Many-to-One-Relation, Relation/Many-to-Many-Relation
Country	Text/Input,Select/Country, Select/Country (MultiSelect)
Html Tag	unsupported
Snippet	unsupported
reCAPTCHA v3	unsupported
Dynamic Multi File	unsupported
Submit	unsupported

Dynamic Choices Mapping

If you're using the dynamic choice type mapping, make sure your mapped opendxp field is connected to the same options provider source!

Container Mapping

This Channel also allows you to store 1:N container data (Repeater, Fieldset) by storing them as a field collection in your data object. You need to add the field collection relation to your form field. After that you're able to sub-map the field collection object.

Dynamic Object Validation Constraints

There are two default validation constrains available within the field collection mapping.

Type	Description
Uniqueness Validation	If enabled, you need to define a referencing uniqueness field. This will raise an GuardOutputWorkflowException exception, if the validation fails. The message will be translated via opendxp translation engine.
Count Validation	If enabled, you ned to define a referencing count field (mostly a number field). This will raise an GuardOutputWorkflowException exception, if the validation fails. The message will be translated via opendxp translation engine.

Events

You're able to implement a guard and enrichment event. Read more about it here.

---

Dynamic Object Resolver

You may want to extend the object channel storage definition to not only store them on a static place but change it individually, based on given form data. A Resolver is strategy aware, which means you're able to define if a resolver should be available for Existing Objects or New Objects or both.

There are two ways to do this: Use the runtime data services or create a custom one:

I. Use Runtime Data Object Resolver

Note: The Runtime Data Object Resolver is only available if you're using the "Use existing Object" strategy! If you need to add more logic, use a custom resolver (see next section "Create a custom Resolver")

Example: You want to show some events on your website. Every event has its own detail page on your website. To allow user to apply to your event, you may want to add a form at the bottom of those event pages. To achieve this, you need to do some configuration work. Luckily, FormBuilder ships some pre-configured services, so you only need to configure them properly.

I. Add Runtime Data Provider

First, you need to determinate an object identifier. Mostly it's an ID in your query string. Were using a runtime data provider to achieve this.

form_builder.form.runtime_data.event_id_fetcher:
    class: OpenDxp\Bundle\FormBuilderBundle\Form\RuntimeData\Provider\RequestDataProvider
    autowire: true
    arguments:
        $expr: 'request.query.get("eventId", null)'
        $runtimeId: 'event_id'
    tags:
        - { name: form_builder.runtime_data_provider}

II. Add Object Resolver

Second, create a dynamic object resolver and append the ID from the runtime data pool.

form_builder.output_workflow.object.dynamic_object_resolver.event:
    class: OpenDxp\Bundle\FormBuilderBundle\OutputWorkflow\DynamicObjectResolver\ObjectByRuntimeDataResolver
    autowire: true
    arguments:
        $runtimeDataId: 'event_id'
        $objectIdentifier: 'name'
        $isLocalizedValue: false
    tags:
        - { name: form_builder.output_workflow.object.dynamic_resolver, identifier: 'my_runtime_object_resolver', label: 'My Runtime Object Resolver'}

II. Create a custom Resolver

App\FormBuilder\OutputWorkflow\DynamicObjectResolver\CustomObjectResolver:
    autowire: true
    tags:
        - { name: form_builder.output_workflow.object.dynamic_resolver, identifier: 'my_dynamic_object_resolver', label: 'My Dynamic Object Resolver'}

<?php

namespace App\FormBuilder\OutputWorkflow\DynamicObjectResolver;

use OpenDxp\Bundle\FormBuilderBundle\OutputWorkflow\Channel\Object\AbstractObjectResolver;
use OpenDxp\Bundle\FormBuilderBundle\OutputWorkflow\DynamicObjectResolver\DynamicObjectResolverInterface;
use OpenDxp\Model\DataObject;
use Symfony\Component\Form\FormInterface;

class CustomObjectResolver implements DynamicObjectResolverInterface
{
    public static function getAllowedObjectResolverModes(): array
    {
        # this service is only allowed when using the "New Object" resolve strategy
        
        return [
            AbstractObjectResolver::OBJECT_RESOLVER_CREATE
        ];
    }

    public function resolve(FormInterface $form, string $dataClass, array $formRuntimeData, string $locale, string $objectResolverMode): ?DataObject
    {
        if ($objectResolverMode !== AbstractObjectResolver::OBJECT_RESOLVER_CREATE) {
            return null;
        }

        if ($dataClass !== 'TestClass') {
            return null;
        }

        $object = new DataObject\TestClass();
        $object->setKey('YOURKEY');
        $object->setParent('YOURPARENT');
        
        // return object, the object mapper will do the rest

        return $object;
    }
}