class MauticAdminSettingsForm in Mautic Integration 8

Configure Mautic settings for this site.

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\mautic\Form\MauticAdminSettingsForm

Expanded class hierarchy of MauticAdminSettingsForm

1 string reference to 'MauticAdminSettingsForm'

mautic.routing.yml in ./mautic.routing.yml: mautic.routing.yml

File

src/Form/MauticAdminSettingsForm.php, line 12

Namespace

Drupal\mautic\Form

View source

class MauticAdminSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('mautic.settings');
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General settings'),
      '#open' => TRUE,
    ];
    $form['general']['mautic_enable'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Include Mautic Javascript Code'),
      '#default_value' => $config
        ->get('mautic_enable'),
      '#description' => $this
        ->t("If you want to embed the Mautic Javascript Code, enable this check."),
      '#required' => FALSE,
    ];
    $form['general']['mautic_base_url'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Mautic URL'),
      '#default_value' => $config
        ->get('mautic_base_url'),
      '#states' => [
        'visible' => [
          ':input[name="mautic_enable"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#size' => 60,
      '#description' => $this
        ->t("Your Mautic javascript code. Example: http(s)://yourmautic.com/mtc.js"),
      '#required' => TRUE,
    ];
    $form['general']['header'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Should the JS snippet be in the header?'),
      '#default_value' => $config
        ->get('header'),
      '#states' => [
        'visible' => [
          ':input[name="mautic_enable"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
      '#description' => $this
        ->t("As default the snippet is in the footer (it is recommended)"),
    ];
    $moduleHandler = \Drupal::service('module_handler');
    if ($moduleHandler
      ->moduleExists('acquia_lift')) {
      $form['general']['lift_enable'] = [
        '#type' => 'checkbox',
        '#title' => $this
          ->t('Include Acquia Personalization Integration Javascript Code'),
        '#default_value' => $config
          ->get('lift_enable'),
        '#description' => $this
          ->t("If you want to embed the Acquia Personalization Integration Javascript Code, enable this check."),
        '#required' => FALSE,
        '#states' => [
          'visible' => [
            ':input[name="mautic_enable"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];
    }
    $form['tracking_page'] = [
      '#type' => 'vertical_tabs',
      '#title' => $this
        ->t('Tracking Page'),
    ];
    $mautic_pages_list = $config
      ->get('visibility.request_path_pages');
    $form['tracking']['page_visibility_settings'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Pages'),
      '#group' => 'tracking_page',
    ];
    if ($config
      ->get('visibility.request_path_mode') == 2) {
      $form['tracking']['page_visibility_settings'] = [];
      $form['tracking']['page_visibility_settings']['mautic_visibility_request_path_mode'] = [
        '#type' => 'value',
        '#value' => 2,
      ];
      $form['tracking']['page_visibility_settings']['mautic_visibility_request_path_pages'] = [
        '#type' => 'value',
        '#value' => $mautic_pages_list,
      ];
    }
    else {
      $options = [
        $this
          ->t('Every page except the listed pages'),
        $this
          ->t('The listed pages only'),
      ];
      $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.", [
        '%blog' => '/blog',
        '%blog-wildcard' => '/blog/*',
        '%front' => '<front>',
      ]);
      $title = $this
        ->t('Pages');
      $form['tracking']['page_visibility_settings']['mautic_visibility_request_path_mode'] = [
        '#type' => 'radios',
        '#title' => $this
          ->t('Add tracking to specific pages'),
        '#options' => $options,
        '#default_value' => $config
          ->get('visibility.request_path_mode'),
      ];
      $form['tracking']['page_visibility_settings']['mautic_visibility_request_path_pages'] = [
        '#type' => 'textarea',
        '#title' => $title,
        '#title_display' => 'invisible',
        '#default_value' => !empty($mautic_pages_list) ? $mautic_pages_list : "/admin\n/admin/*\n/batch\n/node/add*\n/node/*/*\n/user/*/*",
        '#description' => $description,
        '#rows' => 10,
      ];
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $url_is_valid = UrlHelper::isValid($form_state
      ->getValue('mautic_base_url'), $absolute = TRUE);

    // Check if is a valid url.
    if (!$url_is_valid) {
      $form_state
        ->setErrorByName('mautic_base_url', $this
        ->t('The URL is not valid.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('mautic.settings');
    $config
      ->set('mautic_enable', $form_state
      ->getValue('mautic_enable'))
      ->set('mautic_base_url', $form_state
      ->getValue('mautic_base_url'))
      ->set('visibility.request_path_mode', $form_state
      ->getValue('mautic_visibility_request_path_mode'))
      ->set('visibility.request_path_pages', $form_state
      ->getValue('mautic_visibility_request_path_pages'))
      ->set('header', $form_state
      ->getValue('header'))
      ->set('lift_enable', $form_state
      ->getValue('lift_enable'))
      ->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.
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.
MauticAdminSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
MauticAdminSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MauticAdminSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MauticAdminSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
MauticAdminSettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
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 MauticAdminSettingsForm in Mautic Integration 8

Hierarchy

File

Namespace

Members

API Navigation