Important

You are browsing documentation for version 5.1 of OroCommerce, supported until March 2026. Read the documentation for version 6.0 (the latest LTS version) to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Add the Agreements Section to a Custom Checkout Based on the Single Page Checkout Workflow (Example)

Agreements Section

As an illustration, we are going to add the Agreements section to acme_demo_checkout_single_page. Extend save_state and create_order with the customerConsents attribute field in order to display the section.

workflows:
    acme_demo_checkout_single_page:
        transitions:
            # ...
            save_state:
                # ...
                form_options:
                    # ...
                    attribute_fields:
                        # ...
                        customerConsents:
                            form_type: Oro\Bundle\ConsentBundle\Form\Type\ConsentAcceptanceType
                            options:
                                required: true
                                property_path: customerConsents
                        # ...
            # ...
            create_order:
                # ...
                form_options:
                    # ...
                    attribute_fields:
                        # ...
                        customerConsents:
                            form_type: Oro\Bundle\ConsentBundle\Form\Type\ConsentAcceptanceType
                            options:
                                required: true
                                property_path: customerConsents
                       # ...

Next, add the transition definitions that save consents and check that all mandatory consents are accepted.

workflows:
    acme_demo_checkout_single_page:
        transition_definitions:
            # ...
            save_state_definition:
                  # ...
                  - '@assign_value':
                      conditions:
                          '@not':
                              - '@is_consents_accepted':
                                  acceptedConsents: $customerConsents
                      parameters: [$consents_available, true]

                  - '@save_accepted_consents':
                      acceptedConsents: $customerConsents
                  # ...
            # ...
            create_order_transition_definition:
                # ...
                conditions:
                    '@and':
                        # ...
                        - '@is_consents_accepted':
                            acceptedConsents: $customerConsents
                            message: oro.checkout.workflow.condition.required_consents_should_be_checked_on_single_page_checkout.message
                            type: 'warning'
                        # ...
                # ...
                actions:
                    # ...
                    - '@save_accepted_consents':
                        acceptedConsents: $customerConsents
                    # ...

Template

To show a block with the consent items:

1. Import a layout with the consent items and configure it.

   layout:
       imports:
           # ...
           -
               id: oro_consent_items
               namespace: checkout
               root: checkout_consent_container
       actions:
           # ...
           - '@add':
              id: checkout_consent_container
              blockType: container
              parentId: checkout_order_summary_totals_container
              siblingId: checkout_order_summary_totals_sticky_container
              prepend: true
   
           - '@add':
              id: checkout_consent_message
              blockType: consent_acceptance_choice
              parentId: checkout_consent_container
   

2. Customize the templates, as illustrated below.

   {% block _checkout_consent_container_widget %}
       <div {{ block('block_attributes') }}>
           <span class="label label--full text-uppercase">
               {{- 'oro.consent.frontend.checkout.form.sections.data_protection.label'|trans -}}
           </span>
           {{ parent_block_widget(block) }}
       </div>
   {% endblock %}
   
   {% block _checkout_consent_message_widget %}
       {% set attr = layout_attr_defaults(attr, {
           'class': 'notification notification--success'
       }) %}
   
       {% if consents is empty %}
           <div {{ block('block_attributes') }}>
               <span class="notification__item">
                   <i class="fa-check"></i> {{ 'oro.consent.frontend.single_page_checkout.form.messages.all_agreements_accepted'|trans }}
               </span>
           </div>
       {% endif %}
   {% endblock %}