GoogleAnalyticsCounterAuthForm.php in Google Analytics Counter 8.3

Namespace

Drupal\google_analytics_counter\Form

File

src/Form/GoogleAnalyticsCounterAuthForm.php

<?php

namespace Drupal\google_analytics_counter\Form;

use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Url;
use Drupal\google_analytics_counter\GoogleAnalyticsCounterAppManagerInterface;
use Drupal\google_analytics_counter\GoogleAnalyticsCounterAuthManagerInterface;
use Drupal\google_analytics_counter\GoogleAnalyticsCounterHelper;
use Drupal\google_analytics_counter\GoogleAnalyticsCounterMessageManagerInterface;
use Drupal\Core\State\StateInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class GoogleAnalyticsCounterAuthForm.
 *
 * @package Drupal\google_analytics_counter\Form
 */
class GoogleAnalyticsCounterAuthForm extends ConfigFormBase {

  /**
   * The google_analytics_counter.settings config object.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The state keyvalue collection.
   *
   * @var \Drupal\Core\State\StateInterface
   */
  protected $state;

  /**
   * Drupal\google_analytics_counter\GoogleAnalyticsCounterAppManagerInterface.
   *
   * @var \Drupal\google_analytics_counter\GoogleAnalyticsCounterAppManagerInterface
   */
  protected $appManager;

  /**
   * Drupal\google_analytics_counter\GoogleAnalyticsCounterAuthManagerInterface.
   *
   * @var \Drupal\google_analytics_counter\GoogleAnalyticsCounterAuthManagerInterface
   */
  protected $authManager;

  /**
   * The Google Analytics Counter message manager.
   *
   * @var \Drupal\google_analytics_counter\GoogleAnalyticsCounterMessageManagerInterface
   */
  protected $messageManager;

  /**
   * Constructs a new SiteMaintenanceModeForm.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\State\StateInterface $state
   *   The state keyvalue collection to use.
   * @param \Drupal\google_analytics_counter\GoogleAnalyticsCounterAppManagerInterface $app_manager
   *   Google Analytics Counter App Manager object.
   * @param \Drupal\google_analytics_counter\GoogleAnalyticsCounterAuthManagerInterface $auth_manager
   *   Google Analytics Counter Auth Manager object.
   * @param \Drupal\google_analytics_counter\GoogleAnalyticsCounterMessageManagerInterface $message_manager
   *   Google Analytics Counter Message Manager object.
   */
  public function __construct(ConfigFactoryInterface $config_factory, StateInterface $state, GoogleAnalyticsCounterAppManagerInterface $app_manager, GoogleAnalyticsCounterAuthManagerInterface $auth_manager, GoogleAnalyticsCounterMessageManagerInterface $message_manager) {
    parent::__construct($config_factory);
    $this->config = $config_factory
      ->get('google_analytics_counter.settings');
    $this->state = $state;
    $this->appManager = $app_manager;
    $this->authManager = $auth_manager;
    $this->messageManager = $message_manager;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $config = $this
      ->config('google_analytics_counter.settings');
    $form['#tree'] = TRUE;

    // Initialize the feed to trigger the fetching of the tokens.
    $this->authManager
      ->newGaFeed();
    $web_properties = key($this->authManager
      ->getWebPropertiesOptions());
    if ($web_properties === 'unauthenticated') {
      $form['authenticate'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Authenticate with Google Analytics'),
        '#description' => $this
          ->t("This action will redirect you to Google. Login with the account you'd like to use."),
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
      ];
      $form['authenticate']['authenticate_submit'] = [
        '#type' => 'submit',
        '#value' => $this
          ->t('Authenticate'),
      ];
    }
    else {
      if ($config
        ->get('general_settings.client_id') !== '') {
        $form['revoke'] = [
          '#type' => 'fieldset',
          '#title' => $this
            ->t('Revoke authentication'),
          '#description' => $this
            ->t('This action will revoke authentication from Google Analytics.'),
          '#collapsible' => TRUE,
          '#collapsed' => TRUE,
          '#weight' => 5,
        ];
        $form['revoke']['revoke_submit'] = [
          '#type' => 'submit',
          '#value' => $this
            ->t('Revoke authentication'),
        ];
      }
    }
    $markup_description = $this->messageManager
      ->authenticationInstructions($web_properties);
    $form['setup'] = [
      '#type' => 'markup',
      '#markup' => '<h4>' . $this
        ->t('Google Analytics Setup') . '</h4>' . $markup_description,
      '#weight' => 10,
    ];
    $t_args = [
      ':href' => Url::fromUri('http://code.google.com/apis/console')
        ->toString(),
      '@href' => 'Google API Console',
    ];
    $form['client_id'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Client ID'),
      '#default_value' => $config
        ->get('general_settings.client_id'),
      '#size' => 90,
      '#description' => $this
        ->t('Create the Client ID in the access tab of the <a href=:href target="_blank">@href</a>.', $t_args),
      '#weight' => 11,
    ];
    $form['client_secret'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Client Secret'),
      '#default_value' => $config
        ->get('general_settings.client_secret'),
      '#size' => 90,
      '#description' => $this
        ->t('Create the Client secret in the <a href=:href target="_blank">@href</a>.', $t_args),
      '#weight' => 12,
    ];
    $current_path = \Drupal::service('path.current')
      ->getPath();
    $uri = \Drupal::service('path.alias_manager')
      ->getAliasByPath($current_path);
    $description = $this
      ->t('The path that users are redirected to after they have authenticated with Google.<br /> Default: <strong>@default_uri</strong>', [
      '@default_uri' => $base_url . $uri,
    ]);
    $form['redirect_uri'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Authorized Redirect URI'),
      '#default_value' => $config
        ->get('general_settings.redirect_uri'),
      '#size' => 90,
      '#description' => $description,
      '#weight' => 13,
    ];
    $t_args = [
      ':href' => $this->messageManager
        ->googleProjectName(),
      '@href' => 'Analytics API',
    ];
    $form['project_name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Google Project Name'),
      '#default_value' => $config
        ->get('general_settings.project_name'),
      '#description' => $this
        ->t("Optionally add your Google Project's machine name. Machine names are written like <em>project-name</em>. This field helps to take you directly to your <a href=:href>@href</a> page to view quotas.", $t_args),
      '#weight' => 14,
    ];
    $options = $this->authManager
      ->getWebPropertiesOptions();
    $form['profile_id'] = [
      '#type' => 'select',
      '#title' => $this
        ->t("Google View"),
      '#options' => $options,
      '#default_value' => $config
        ->get('general_settings.profile_id'),
      '#description' => $this
        ->t("Choose a Google Analytics view. If you are not authenticated or if the project you are authenticating to does not have Analytics, no options are available."),
      '#weight' => 15,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('google_analytics_counter.settings');
    switch ($form_state
      ->getValue('op')) {
      case (string) $this
        ->t('Authenticate'):
        $this->authManager
          ->beginGacAuthentication();
        break;
      case (string) $this
        ->t('Revoke authentication'):
        $form_state
          ->setRedirectUrl(Url::fromRoute('google_analytics_counter.admin_auth_revoke'));
        break;
      default:
        $options = $this->authManager
          ->getWebPropertiesOptions();
        $profile_id = $form_state
          ->getValue('profile_id');
        $profile_name = GoogleAnalyticsCounterHelper::searchArrayValueByKey($options, (int) $profile_id);
        $config
          ->set('general_settings.client_id', $form_state
          ->getValue('client_id'))
          ->set('general_settings.client_secret', $form_state
          ->getValue('client_secret'))
          ->set('general_settings.redirect_uri', $form_state
          ->getValue('redirect_uri'))
          ->set('general_settings.project_name', $form_state
          ->getValue('project_name'))
          ->set('general_settings.profile_id', $form_state
          ->getValue('profile_id'))
          ->set('general_settings.profile_name', $profile_name)
          ->save();
        parent::submitForm($form, $form_state);
        break;
    }
  }

}

Classes

Name	Description
GoogleAnalyticsCounterAuthForm	Class GoogleAnalyticsCounterAuthForm.