You are here

Home » API reference » Googalytics - Google Analytics 8 » GlobalForm.php

class GlobalForm in Googalytics - Google Analytics 8

Form for editing Google Analytics Global Dimensions settings.

Hierarchy

Expanded class hierarchy of GlobalForm

1 string reference to 'GlobalForm'
ga_tokens.routing.yml in modules/ga_tokens/ga_tokens.routing.yml
modules/ga_tokens/ga_tokens.routing.yml

File

modules/ga_tokens/src/Form/GlobalForm.php, line 14

Namespace

Drupal\ga_tokens\Form
View source 
class GlobalForm extends ConfigFormBase {

  /**
   * The Module Handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  private $moduleHandler;

  /**
   * GlobalForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The Config Factory service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler
   *   The Module Handler service.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ModuleHandlerInterface $moduleHandler) {
    parent::__construct($config_factory);
    $this->moduleHandler = $moduleHandler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'ga_tokens_global';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'ga_tokens.global',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $gaConfig = $this
      ->config('ga.settings');
    $gaTokenGlobalConfig = $this
      ->config('ga_tokens.global');
    $premium = $gaConfig
      ->get('premium');
    $groupCount = $premium ? 10 : 1;
    if ($premium) {
      $form['dimensions'] = [
        '#type' => 'vertical_tabs',
        '#title' => $this
          ->t('Dimensions'),
        '#description' => $this
          ->t("Custom dimensions must be configured via the Google Analytics Management Interface."),
      ];
    }
    for ($groupIndex = 0; $groupIndex < $groupCount; $groupIndex++) {
      if ($premium) {
        $form['dimensiongroup' . $groupIndex] = [
          '#type' => 'details',
          '#group' => 'dimensions',
          '#title' => $this
            ->t('Dimensions %start to %end', [
            '%start' => $groupIndex * 20 + 1,
            '%end' => ($groupIndex + 1) * 20,
          ]),
          '#tree' => TRUE,
        ];
      }
      else {
        $form['dimensiongroup' . $groupIndex] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Dimensions'),
          '#description' => $this
            ->t("Custom dimensions must be configured via the Google Analytics Management Interface."),
          '#tree' => TRUE,
        ];
      }
      $form['dimensiongroup' . $groupIndex]['table'] = [
        '#type' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Index'),
          ],
          [
            'data' => $this
              ->t('Label'),
          ],
          [
            'data' => $this
              ->t('Value'),
          ],
        ],
      ];
      for ($i = $groupIndex * 20 + 1; $i <= ($groupIndex + 1) * 20; $i++) {
        $form['dimensiongroup' . $groupIndex]['table'][$i]['index'] = [
          '#type' => 'markup',
          '#markup' => $i,
        ];
        $form['dimensiongroup' . $groupIndex]['table'][$i]['label'] = [
          '#type' => 'textfield',
          '#parents' => [
            'dimensions',
            $i,
            'label',
          ],
          '#title' => $this
            ->t('Label'),
          '#title_display' => 'invisible',
          '#default_value' => $gaTokenGlobalConfig
            ->get('dimensions.' . $i . '.label') ?: '',
          '#size' => 30,
        ];
        $form['dimensiongroup' . $groupIndex]['table'][$i]['value'] = [
          '#type' => 'textfield',
          '#parents' => [
            'dimensions',
            $i,
            'value',
          ],
          '#title' => $this
            ->t('Value'),
          '#title_display' => 'invisible',
          '#default_value' => $gaTokenGlobalConfig
            ->get('dimensions.' . $i . '.value') ?: '',
          '#element_validate' => [
            'token_element_validate',
          ],
          '#token_types' => [],
        ];
      }
      if ($this->moduleHandler
        ->moduleExists('token')) {
        $form['dimensiongroup' . $groupIndex]['table']['token_help']['index'] = [];
        $form['dimensiongroup' . $groupIndex]['table']['token_help']['label'] = [];
        $form['dimensiongroup' . $groupIndex]['table']['token_help']['value'] = [
          '#theme' => 'token_tree_link',
          '#token_types' => [],
        ];
      }
    }
    if ($premium) {
      $form['metrics'] = [
        '#type' => 'vertical_tabs',
        '#title' => $this
          ->t('Metrics'),
        '#description' => $this
          ->t("Custom metrics must be configured via the Google Analytics Management Interface."),
        '#tree' => TRUE,
      ];
    }
    for ($groupIndex = 0; $groupIndex < $groupCount; $groupIndex++) {
      if ($premium) {
        $form['metricgroup' . $groupIndex] = [
          '#type' => 'details',
          '#group' => 'metrics',
          '#title' => $this
            ->t('Metrics %start to %end', [
            '%start' => $groupIndex * 20 + 1,
            '%end' => ($groupIndex + 1) * 20,
          ]),
          '#tree' => TRUE,
        ];
      }
      else {
        $form['metricgroup' . $groupIndex] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Metrics'),
          '#description' => $this
            ->t("Custom metrics must be configured via the Google Analytics Management Interface."),
          '#tree' => TRUE,
        ];
      }
      $form['metricgroup' . $groupIndex]['table'] = [
        '#type' => 'table',
        '#header' => [
          [
            'data' => $this
              ->t('Index'),
          ],
          [
            'data' => $this
              ->t('Label'),
          ],
          [
            'data' => $this
              ->t('Value'),
          ],
        ],
      ];
      for ($i = $groupIndex * 20 + 1; $i <= ($groupIndex + 1) * 20; $i++) {
        $form['metricgroup' . $groupIndex]['table'][$i]['index'] = [
          '#type' => 'markup',
          '#markup' => $i,
        ];
        $form['metricgroup' . $groupIndex]['table'][$i]['label'] = [
          '#type' => 'textfield',
          '#parents' => [
            'metrics',
            $i,
            'label',
          ],
          '#title' => $this
            ->t('Label'),
          '#title_display' => 'invisible',
          '#default_value' => $gaTokenGlobalConfig
            ->get('metrics.' . $i . '.label') ?: '',
          '#size' => 30,
        ];
        $form['metricgroup' . $groupIndex]['table'][$i]['value'] = [
          '#type' => 'textfield',
          '#parents' => [
            'metrics',
            $i,
            'value',
          ],
          '#title' => $this
            ->t('Value'),
          '#title_display' => 'invisible',
          '#default_value' => $gaTokenGlobalConfig
            ->get('metrics.' . $i . '.value') ?: '',
          '#element_validate' => [
            'token_element_validate',
          ],
          '#token_types' => [],
        ];
      }
      if ($this->moduleHandler
        ->moduleExists('token')) {
        $form['metricgroup' . $groupIndex]['table']['token_help']['index'] = [];
        $form['metricgroup' . $groupIndex]['table']['token_help']['label'] = [];
        $form['metricgroup' . $groupIndex]['table']['token_help']['value'] = [
          '#theme' => 'token_tree_link',
          '#token_types' => [],
        ];
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $dimensions = [];
    foreach ($form_state
      ->getValues()['dimensions'] as $index => $dimension) {
      if (!empty($dimension['label']) || !empty($dimension['value'])) {
        $dimensions[$index] = [
          'label' => $dimension['label'],
          'value' => $dimension['value'],
        ];
      }
    }
    $metrics = [];
    foreach ($form_state
      ->getValues()['metrics'] as $index => $metric) {
      if (!empty($metric['label']) || !empty($metric['value'])) {
        $metrics[$index] = [
          'label' => $metric['label'],
          'value' => $metric['value'],
        ];
      }
    }
    $this
      ->config('ga_tokens.global')
      ->set('dimensions', $dimensions)
      ->set('metrics', $metrics)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigFormBaseTrait::config protected function Retrieves a configuration object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
GlobalForm::$moduleHandler private property The Module Handler service.
GlobalForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
GlobalForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
GlobalForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
GlobalForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
GlobalForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
GlobalForm::__construct public function GlobalForm constructor. Overrides ConfigFormBase::__construct
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.