public function GoogleTagManager::buildConfigurationForm in Analytics 8

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides ServicePluginBase::buildConfigurationForm

File

src/Plugin/AnalyticsService/GoogleTagManager.php, line 41

Class

GoogleTagManager

Google Tag Manager analytics service plugin.

Namespace

Drupal\analytics\Plugin\AnalyticsService

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['container_id'] = [
    '#type' => 'textfield',
    '#title' => t('Container ID'),
    '#default_value' => $this->configuration['container_id'],
    '#required' => TRUE,
    '#size' => 15,
    '#placeholder' => 'GTM-XXXX',
  ];
  $form['data_layer'] = [
    '#type' => 'details',
    '#title' => $this
      ->t('Data Layer'),
    '#open' => TRUE,
  ];
  $form['data_layer']['name'] = [
    '#type' => 'textfield',
    '#title' => t('Data Layer variable'),
    '#default_value' => $this->configuration['data_layer']['name'],
    '#size' => 15,
    '#required' => TRUE,
  ];
  $form['data_layer']['value'] = [
    '#type' => 'textarea',
    '#title' => t('Data Layer value JSON'),
    '#default_value' => $this->configuration['data_layer']['value'],
    '#element_validate' => [
      [
        get_class($this),
        'validateJson',
      ],
    ],
  ];
  $form['optimize_anti_flicker'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Add the <a href="@url">Optimize anti-flicker snippet</a>', [
      '@url' => 'https://support.google.com/optimize/answer/7100284',
    ]),
    '#description' => $this
      ->t('If you notice page flicker when using Google Optimize, adding this snippet can help.'),
    '#default_value' => $this->configuration['optimize_anti_flicker'],
    '#weight' => 50,
    '#return_value' => TRUE,
  ];
  return $form;
}