You are here

Home » API reference » Hotjar 8 » HotjarAdminSettingsForm.php

class HotjarAdminSettingsForm in Hotjar 8

Same name and namespace in other branches
  1. 8.2 src/Form/HotjarAdminSettingsForm.php \Drupal\hotjar\Form\HotjarAdminSettingsForm

Configure Hotjar settings for this site.

Hierarchy

Expanded class hierarchy of HotjarAdminSettingsForm

1 string reference to 'HotjarAdminSettingsForm'
hotjar.routing.yml in ./hotjar.routing.yml
hotjar.routing.yml

File

src/Form/HotjarAdminSettingsForm.php, line 15

Namespace

Drupal\hotjar\Form
View source 
class HotjarAdminSettingsForm extends ConfigFormBase {

  /**
   * Hotjar settings.
   *
   * @var \Drupal\hotjar\HotjarSettingsInterface
   */
  protected $hotjarSettings;

  /**
   * Snippet builder.
   *
   * @var \Drupal\hotjar\SnippetBuilderInterface
   */
  protected $snippetBuilder;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, HotjarSettingsInterface $hotjar_settings, SnippetBuilderInterface $snippet_builder) {
    parent::__construct($config_factory);
    $this->hotjarSettings = $hotjar_settings;
    $this->snippetBuilder = $snippet_builder;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General settings'),
      '#open' => TRUE,
    ];
    $form['general']['hotjar_account'] = [
      '#default_value' => $this->hotjarSettings
        ->getSetting('account'),
      '#description' => $this
        ->t('Your Hotjar ID can be found in your tracking code on the line <code>h._hjSettings={hjid:<b>12345</b>,hjsv:5};</code> where <code><b>12345</b></code> is your Hotjar ID'),
      '#maxlength' => 20,
      '#required' => TRUE,
      '#size' => 15,
      '#title' => $this
        ->t('Hotjar ID'),
      '#type' => 'textfield',
    ];
    $form['general']['hotjar_snippet_version'] = [
      '#default_value' => $this->hotjarSettings
        ->getSetting('snippet_version'),
      '#description' => $this
        ->t('Your Hotjar snippet version is near your Hotjar ID<code>h._hjSettings={hjid:12345,hjsv:<b>5</b>};</code> where <code><b>5</b></code> is your Hotjar snippet version'),
      '#maxlength' => 10,
      '#required' => TRUE,
      '#size' => 5,
      '#title' => $this
        ->t('Hotjar snippet version'),
      '#type' => 'textfield',
    ];
    $visibility = $this->hotjarSettings
      ->getSetting('visibility_pages');
    $pages = $this->hotjarSettings
      ->getSetting('pages');

    // Visibility settings.
    $form['tracking']['page_track'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Pages'),
      '#group' => 'tracking_scope',
      '#open' => TRUE,
    ];
    if ($visibility == 2) {
      $form['tracking']['page_track'] = [];
      $form['tracking']['page_track']['hotjar_visibility_pages'] = [
        '#type' => 'value',
        '#value' => 2,
      ];
      $form['tracking']['page_track']['hotjar_pages'] = [
        '#type' => 'value',
        '#value' => $pages,
      ];
    }
    else {
      $options = [
        $this
          ->t('Every page except the listed pages'),
        $this
          ->t('The listed pages only'),
      ];
      $description_args = [
        '%blog' => 'blog',
        '%blog-wildcard' => 'blog/*',
        '%front' => '<front>',
      ];
      $description = $this
        ->t("Specify pages by using their paths. Enter one path per line. The '*' character is a wildcard. Example paths are %blog for the blog page and %blog-wildcard for every personal blog. %front is the front page.", $description_args);
      $title = $this
        ->t('Pages');
      $form['tracking']['page_track']['hotjar_visibility_pages'] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('Add tracking to specific pages'),
        '#options' => $options,
        '#default_value' => $visibility,
      ];
      $form['tracking']['page_track']['hotjar_pages'] = [
        '#type' => 'textarea',
        '#title' => $title,
        '#title_display' => 'invisible',
        '#default_value' => $pages,
        '#description' => $description,
        '#rows' => 10,
      ];
    }

    // Render the role overview.
    $visibility_roles = $this->hotjarSettings
      ->getSetting('roles');
    $form['tracking']['role_track'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Roles'),
      '#group' => 'tracking_scope',
      '#open' => TRUE,
    ];
    $form['tracking']['role_track']['hotjar_visibility_roles'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Add tracking for specific roles'),
      '#options' => [
        $this
          ->t('Add to the selected roles only'),
        $this
          ->t('Add to every role except the selected ones'),
      ],
      '#default_value' => $this->hotjarSettings
        ->getSetting('visibility_roles'),
    ];
    $role_options = array_map([
      '\\Drupal\\Component\\Utility\\SafeMarkup',
      'checkPlain',
    ], user_role_names());
    $form['tracking']['role_track']['hotjar_roles'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Roles'),
      '#default_value' => !empty($visibility_roles) ? $visibility_roles : [],
      '#options' => $role_options,
      '#description' => $this
        ->t('If none of the roles are selected, all users will be tracked. If a user has any of the roles checked, that user will be tracked (or excluded, depending on the setting above).'),
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    // Trim some text values.
    $form_state
      ->setValue('hotjar_account', trim($form_state
      ->getValue('hotjar_account')));
    $form_state
      ->setValue('hotjar_snippet_version', trim($form_state
      ->getValue('hotjar_snippet_version')));
    $form_state
      ->setValue('hotjar_pages', trim($form_state
      ->getValue('hotjar_pages')));
    $form_state
      ->setValue('hotjar_roles', array_filter($form_state
      ->getValue('hotjar_roles')));

    // Verify that every path is prefixed with a slash.
    if ($form_state
      ->getValue('hotjar_visibility_pages') != 2) {
      $pages = preg_split('/(\\r\\n?|\\n)/', $form_state
        ->getValue('hotjar_pages'));
      foreach ($pages as $page) {
        if (strpos($page, '/') !== 0 && $page !== '<front>') {
          $form_state
            ->setErrorByName('hotjar_pages', $this
            ->t('Path "@page" not prefixed with slash.', [
            '@page' => $page,
          ]));

          // Drupal forms show one error only.
          break;
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('hotjar.settings');
    $config
      ->set('account', $form_state
      ->getValue('hotjar_account'))
      ->set('snippet_version', $form_state
      ->getValue('hotjar_snippet_version'))
      ->set('visibility_pages', $form_state
      ->getValue('hotjar_visibility_pages'))
      ->set('pages', $form_state
      ->getValue('hotjar_pages'))
      ->set('visibility_roles', $form_state
      ->getValue('hotjar_visibility_roles'))
      ->set('roles', $form_state
      ->getValue('hotjar_roles'))
      ->save();
    parent::submitForm($form, $form_state);
    $this->snippetBuilder
      ->createAssets();
  }

}

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.
HotjarAdminSettingsForm::$hotjarSettings protected property Hotjar settings.
HotjarAdminSettingsForm::$snippetBuilder protected property Snippet builder.
HotjarAdminSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
HotjarAdminSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
HotjarAdminSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
HotjarAdminSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
HotjarAdminSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
HotjarAdminSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
HotjarAdminSettingsForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. 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.