class GoogleOptimizeAdminSettingsForm in Google Optimize 8

Implements Google Optimize Admin Settings form.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
  - class \Drupal\google_optimize\Form\GoogleOptimizeAdminSettingsForm

Expanded class hierarchy of GoogleOptimizeAdminSettingsForm

1 string reference to 'GoogleOptimizeAdminSettingsForm'

google_optimize.routing.yml in ./google_optimize.routing.yml: google_optimize.routing.yml

File

src/Form/GoogleOptimizeAdminSettingsForm.php, line 11

Namespace

Drupal\google_optimize\Form

View source

class GoogleOptimizeAdminSettingsForm extends ConfigFormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'google_analytics_admin_form';
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $config = $this
      ->config('google_analytics.settings');
    if (!$config
      ->get('account') ?: '') {
      $this
        ->messenger()
        ->addError($this
        ->t('Unable to get the Google Analytics account. Is Google Analytics installed and configured with your Google Analytics account ID?'));
    }
    $form['containers'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Google Optimize'),
    ];
    $form['containers']['container_ids'] = [
      '#title' => $this
        ->t('Container Ids (GTM-XXXXXX), separated by commas'),
      '#type' => 'textfield',
      '#default_value' => implode(',', google_optimize_container_ids()),
      '#description' => $this
        ->t('A list of Optimize container IDs (separated by commas if more than one)'),
      '#maxlength' => 500,
    ];
    $form['hide_page'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Google Optimize page-hiding snippet'),
    ];
    $form['hide_page']['enabled'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Enabled Google Optimize page-hiding snippet'),
    ];
    $form['hide_page']['enabled']['hide_page_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable'),
      '#default_value' => google_optimize_hide_page_enabled(),
      '#description' => $this
        ->t('Enable/disable the Google Optimize page-hiding snippet.'),
    ];
    $form['hide_page']['settings'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Settings for the Google Optimize page-hiding snippet'),
      '#states' => [
        'visible' => [
          ':input[name="hide_page_enable"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['hide_page']['settings']['hide_page_timeout'] = [
      '#title' => $this
        ->t('Timeout'),
      '#type' => 'textfield',
      '#default_value' => google_optimize_hide_page_timeout(),
      '#description' => $this
        ->t('The default amount of time Optimize will wait before removing the .async-hide class from the html element'),
    ];
    $form['hide_page']['settings']['hide_page_class_name'] = [
      '#title' => $this
        ->t('Class name'),
      '#type' => 'textfield',
      '#default_value' => google_optimize_hide_page_class_name(),
      '#description' => $this
        ->t('If the async-hide class name is already defined in your CSS, you can choose a different name.'),
    ];
    $form['hide_page']['settings']['hide_page_pages'] = [
      '#title' => $this
        ->t('Pages to add the snippet (leave blank for all pages)'),
      '#type' => 'textarea',
      '#default_value' => google_optimize_hide_page_pages(),
      '#description' => $this
        ->t('Specify pages by using their paths. Enter one path per line. The \'*\' character is a wildcard. An example path is /user/* for every user page or /node/123. &lt;front&gt; is the front page.'),
    ];
    $form['hide_page']['settings']['hide_page_roles'] = array(
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Add the snippet for specific roles'),
      '#default_value' => google_optimize_hide_page_roles(),
      '#options' => user_role_names(),
      '#description' => $this
        ->t('Add the snippet only for the selected role(s). If none of the roles are selected, all users will have the snippet.'),
    );
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this->configFactory
      ->getEditable('google_optimize.settings')
      ->set('hide_page_enable', $form_state
      ->getValue('hide_page_enable'))
      ->set('container_ids', $form_state
      ->getValue('container_ids'))
      ->set('hide_page_timeout', $form_state
      ->getValue('hide_page_timeout'))
      ->set('hide_page_class_name', $form_state
      ->getValue('hide_page_class_name'))
      ->set('hide_page_pages', $form_state
      ->getValue('hide_page_pages'))
      ->set('hide_page_roles', $form_state
      ->getValue('hide_page_roles'))
      ->save();

    // Add the container id(s) to Google Analytics.
    $config = $this->configFactory
      ->getEditable('google_analytics.settings');
    $codesnippet = $config
      ->get('codesnippet');

    // Get the google_analytics version. The module does not have version info
    // So get from composer.json. If no composer.json then nothing can be done.
    $version = '';
    if ($info = json_decode(file_get_contents(realpath('composer.json')))) {
      foreach ($info->require as $key => $value) {
        if ($key == 'drupal/google_analytics') {
          $version = $value;
          break;
        }
      }
    }
    if (strpos($version, '3') === 0) {
      $codesnippet['before'] = "optimize_id|" . $form_state
        ->getValue('container_ids');
    }
    else {
      $codesnippet['before'] = "ga('require', '" . $form_state
        ->getValue('container_ids') . "');";
    }
    $config
      ->set('codesnippet', $codesnippet)
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
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
GoogleOptimizeAdminSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
GoogleOptimizeAdminSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
GoogleOptimizeAdminSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
GoogleOptimizeAdminSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
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.

You are here

class GoogleOptimizeAdminSettingsForm in Google Optimize 8

Hierarchy

File

Namespace

Members

API Navigation