View source
<?php
namespace Drupal\hotjar\Form;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StreamWrapper\StreamWrapperManager;
use Drupal\Core\StreamWrapper\StreamWrapperManagerInterface;
use Drupal\hotjar\HotjarSettingsInterface;
use Drupal\hotjar\SnippetBuilderInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
class HotjarAdminSettingsForm extends ConfigFormBase {
protected $snippetBuilder;
protected $streamWrapperManager;
public function __construct(ConfigFactoryInterface $config_factory, SnippetBuilderInterface $snippet_builder, StreamWrapperManagerInterface $stream_wrapper_manager) {
parent::__construct($config_factory);
$this->snippetBuilder = $snippet_builder;
$this->streamWrapperManager = $stream_wrapper_manager;
}
public static function create(ContainerInterface $container) {
return new static($container
->get('config.factory'), $container
->get('hotjar.snippet'), $container
->get('stream_wrapper_manager'));
}
public function getFormId() {
return 'hotjar_admin_settings';
}
protected function getEditableConfigNames() {
return [
'hotjar.settings',
];
}
public function buildForm(array $form, FormStateInterface $form_state) {
$settings = $this
->config('hotjar.settings');
$form['general'] = [
'#type' => 'details',
'#title' => $this
->t('General settings'),
'#open' => TRUE,
];
$form['general']['hotjar_account'] = [
'#default_value' => $settings
->get('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::version};</code> where <code><b>12345</b></code> is your Hotjar ID', [
':version' => HotjarSettingsInterface::HOTJAR_SNIPPET_VERSION,
]),
'#maxlength' => 20,
'#required' => TRUE,
'#size' => 15,
'#title' => $this
->t('Hotjar ID'),
'#type' => 'textfield',
];
$form['general']['hotjar_snippet_version'] = [
'#default_value' => $settings
->get('snippet_version'),
'#description' => $this
->t('Your Hotjar snippet version is near your Hotjar ID<code>h._hjSettings={hjid:12345,hjsv:<b>:version</b>};</code> where <code><b>:version</b></code> is your Hotjar snippet version', [
':version' => HotjarSettingsInterface::HOTJAR_SNIPPET_VERSION,
]),
'#maxlength' => 10,
'#required' => TRUE,
'#size' => 5,
'#title' => $this
->t('Hotjar snippet version'),
'#type' => 'textfield',
];
$form['attachment'] = [
'#type' => 'details',
'#title' => $this
->t('Attachment mode'),
'#open' => TRUE,
];
$asset_mode_options = [
HotjarSettingsInterface::ATTACHMENT_MODE_BUILD => $this
->t('Build', [], [
'context' => 'hotjar',
]),
HotjarSettingsInterface::ATTACHMENT_MODE_DRUPAL_SETTINGS => $this
->t('Asset with Drupal settings', [], [
'context' => 'hotjar',
]),
];
$selected_mode = $settings
->get('attachment_mode');
if (empty($selected_mode)) {
$selected_mode = HotjarSettingsInterface::ATTACHMENT_MODE_BUILD;
}
$form['attachment']['hotjar_attachment_mode'] = [
'#default_value' => $selected_mode,
'#required' => TRUE,
'#title' => $this
->t('Attachment mode'),
'#type' => 'select',
'#options' => $asset_mode_options,
'#description' => $this
->t('<b>:build_label</b>: your attachment will be generated when this form saved.<br/><b>:asset_label</b>: Hotjar ID and snippet version will be delivered as <code>drupalSetting</code> and attached as normal Drupal JS behaviour.', [
':build_label' => $asset_mode_options[HotjarSettingsInterface::ATTACHMENT_MODE_BUILD],
':asset_label' => $asset_mode_options[HotjarSettingsInterface::ATTACHMENT_MODE_DRUPAL_SETTINGS],
], [
'context' => 'hotjar',
]),
];
$snippet_path = $settings
->get('snippet_path');
if (!isset($snippet_path)) {
$snippet_path = HotjarSettingsInterface::HOTJAR_SNIPPET_PATH;
}
$form['attachment']['hotjar_snippet_path'] = [
'#default_value' => $snippet_path,
'#description' => $this
->t('Path to save built JS snippet.'),
'#maxlength' => 150,
'#title' => $this
->t('Hotjar snippet path'),
'#type' => 'textfield',
'#states' => [
'required' => [
':input[name="mode"]' => [
'value' => HotjarSettingsInterface::ATTACHMENT_MODE_BUILD,
],
],
],
];
$visibility = $settings
->get('visibility_pages');
$pages = $settings
->get('pages');
$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,
];
}
$visibility_roles = $settings
->get('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' => $settings
->get('visibility_roles'),
];
$role_options = array_map([
'\\Drupal\\Component\\Utility\\Html',
'escape',
], 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);
}
public function validateForm(array &$form, FormStateInterface $form_state) {
parent::validateForm($form, $form_state);
$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_snippet_path', trim($form_state
->getValue('hotjar_snippet_path')));
$form_state
->setValue('hotjar_attachment_mode', trim($form_state
->getValue('hotjar_attachment_mode')));
$pages = _hotjar_clean_pages_value($form_state
->getValue('hotjar_pages'));
$form_state
->setValue('hotjar_pages', $pages);
$form_state
->setValue('hotjar_roles', array_filter($form_state
->getValue('hotjar_roles')));
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,
]));
break;
}
}
}
$scheme = StreamWrapperManager::getScheme($form_state
->getValue('hotjar_snippet_path'));
if (!$this->streamWrapperManager
->isValidScheme($scheme)) {
$form_state
->setErrorByName('hotjar_snippet_path', $this
->t('Snippet path must starts with <code>public://</code>, <code>private://</code> or any other valid file stream.'));
}
}
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('snippet_path', $form_state
->getValue('hotjar_snippet_path'))
->set('attachment_mode', $form_state
->getValue('hotjar_attachment_mode'))
->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();
}
}