You are here

Home » API reference » Pardot Integration 8 » PardotSettingsForm.php

class PardotSettingsForm in Pardot Integration 8

Configure Pardot settings for this site.

Hierarchy

Expanded class hierarchy of PardotSettingsForm

File

src/Form/PardotSettingsForm.php, line 15

Namespace

Drupal\Pardot\Form
View source 
class PardotSettingsForm extends ConfigFormBase {

  /**
   * Configuration settings.
   */
  protected $settings;

  /**
   * @var \Drupal\system\Plugin\Condition\RequestPath $path_condition.
   */
  protected $path_condition;

  /**
   * @var \Drupal\user\Plugin\Condition\UserRole $user_role_condition.
   */
  protected $user_role_condition;

  /**
   * PardotSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Component\Plugin\Factory\FactoryInterface $plugin_factory
   *   The condition plugin factory.
   */
  public function __construct(ConfigFactoryInterface $config_factory, ExecutableManagerInterface $plugin_factory) {
    parent::__construct($config_factory);

    // Load from pardot.settings.yml.
    $this->settings = $this
      ->config('pardot.settings');

    // Create condition plugins.
    $this->path_condition = $plugin_factory
      ->createInstance('request_path');
    $this->user_role_condition = $plugin_factory
      ->createInstance('user_role');
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return array(
      'pardot.settings',
    );
  }

  /**
   * Build Pardot Settings form.
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['pardot_settings'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('General Settings'),
      '#description' => $this
        ->t('General settings applicable to all Pardot functionality.'),
      '#open' => TRUE,
    );
    $form['pardot_settings']['account_id'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pardot Account ID'),
      '#description' => $this
        ->t('The value shown in the Pardot demo script for piAId. eg. if the script has piAId = "1001"; this field should be 1001.'),
      '#required' => TRUE,
      '#size' => 20,
      '#maxlength' => 64,
      '#default_value' => $this->settings
        ->get('account_id'),
    );
    $form['pardot_settings']['default_campaign_id'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Default Pardot Campaign ID'),
      '#description' => $this
        ->t('The value shown in the Pardot demo script for piCId. eg. if the script has piCId = "1001"; this field should be 1001.'),
      '#required' => TRUE,
      '#size' => 20,
      '#maxlength' => 64,
      '#default_value' => $this->settings
        ->get('default_campaign_id'),
    );

    // Add tracking scope vertical tabs.
    $form['tracking_scope'] = array(
      '#type' => 'item',
      '#title' => $this
        ->t('Tracking scope'),
      '#description' => $this
        ->t('Configuration to include/exclude the Pardot tracking code. The tracking code, with default Campaign ID, will be added to the site paths according to this configuration. Additional campaigns can be added to override the default campaign on specific paths included within this configuration.'),
    );
    $form['tracking_scope_tabs'] = array(
      '#type' => 'vertical_tabs',
      '#title' => $this
        ->t('Tracking Scope Conditions'),
      '#title_display' => 'invisible',
      '#default_tab' => 'pages',
    );

    // Set and build the request_path condition configuration form elements.
    $this->path_condition
      ->setConfiguration($this->settings
      ->get('path_condition'));
    $form += $this->path_condition
      ->buildConfigurationForm($form, $form_state);
    if (isset($form['pages'])) {
      $form['pages']['pages'] = $form['pages'];
      $form['pages']['negate'] = $form['negate'];
      unset($form['pages']['#description']);
      unset($form['negate']);
      $form['pages']['#type'] = 'details';
      $form['pages']['#group'] = 'tracking_scope_tabs';
      $form['pages']['#title'] = $this
        ->t('Pages');
      $form['pages']['negate']['#type'] = 'radios';
      $form['pages']['negate']['#title_display'] = 'invisible';
      $form['pages']['negate']['#options'] = array(
        $this
          ->t('Show for the listed pages'),
        $this
          ->t('Hide for the listed pages'),
      );
      $form['pages']['negate']['#default_value'] = (int) $form['pages']['negate']['#default_value'];
    }

    // Set and build the user_role condition configuration form elements.
    $this->user_role_condition
      ->setConfiguration($this->settings
      ->get('user_role_condition'));
    $form += $this->user_role_condition
      ->buildConfigurationForm($form, $form_state);
    if (isset($form['roles'])) {
      $form['roles']['roles'] = $form['roles'];
      $form['roles']['negate'] = $form['negate'];
      unset($form['roles']['#description']);
      unset($form['negate']);
      $form['roles']['#type'] = 'details';
      $form['roles']['#group'] = 'tracking_scope_tabs';
      $form['roles']['#title'] = $this
        ->t('Roles');
      $form['roles']['negate']['#type'] = 'value';
      $form['roles']['negate']['#default_value'] = FALSE;
    }
    return parent::buildForm($form, $form_state);
  }

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

    // @Todo: replace custom validation with plugin validation, if core
    // issue gets included: https://www.drupal.org/node/2843992.
    // $this->path_condition->validateConfigurationForm($form, $form_state);
    // Validates path conditions to ensure they have leading forward slash.
    $paths = explode("\r\n", $form_state
      ->getValue('pages'));
    foreach ($paths as $path) {
      if (empty($path) || $path === '<front>' || strpos($path, '/') === 0) {
        continue;
      }
      else {
        $message = $this
          ->t('Paths require a leading forward slash when used with the Tracking Scope Pages setting.');
        $form_state
          ->setErrorByName('pages', $message);
        return;
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Submit condition plugin configurations.
    $this->path_condition
      ->submitConfigurationForm($form, $form_state);
    $this->user_role_condition
      ->submitConfigurationForm($form, $form_state);

    // Save configuration to settings.
    $this
      ->config('pardot.settings')
      ->set('account_id', Html::escape($form_state
      ->getValue('account_id')))
      ->set('default_campaign_id', Html::escape($form_state
      ->getValue('default_campaign_id')))
      ->set('path_condition', $this->path_condition
      ->getConfiguration())
      ->set('user_role_condition', $this->user_role_condition
      ->getConfiguration())
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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.
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.
PardotSettingsForm::$path_condition protected property
PardotSettingsForm::$settings protected property Configuration settings.
PardotSettingsForm::$user_role_condition protected property
PardotSettingsForm::buildForm public function Build Pardot Settings form. Overrides ConfigFormBase::buildForm
PardotSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
PardotSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
PardotSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
PardotSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
PardotSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
PardotSettingsForm::__construct public function PardotSettingsForm constructor. Overrides ConfigFormBase::__construct
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.