class SettingsForm in Siteimprove 8

Siteimprove settings.

@package Drupal\siteimprove\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\siteimprove\Form\SettingsForm

Expanded class hierarchy of SettingsForm

1 string reference to 'SettingsForm'

siteimprove.routing.yml in ./siteimprove.routing.yml: siteimprove.routing.yml

File

src/Form/SettingsForm.php, line 22

Namespace

Drupal\siteimprove\Form

View source

class SettingsForm extends ConfigFormBase {

  /**
   * SiteimproveUtils var.
   *
   * @var \Drupal\siteimprove\SiteimproveUtils
   */
  protected $siteimprove;

  /**
   * Drupal\siteimprove\Plugin\SiteimproveDomainManager definition.
   *
   * @var \Drupal\siteimprove\Plugin\SiteimproveDomainManager
   */
  protected $pluginManagerSiteimproveDomain;

  /**
   * Drupal Core Messenger service.
   *
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * Drupal built-in HTTP client service.
   *
   * @var \GuzzleHttp\Client
   */
  protected $httpClient;

  /**
   * {@inheritdoc}
   */
  public function __construct(ConfigFactoryInterface $config_factory, SiteimproveUtils $siteimprove, SiteimproveDomainManager $pluginManagerSiteimproveDomain, Messenger $messenger, Client $httpClient) {
    parent::__construct($config_factory);
    $this->siteimprove = $siteimprove;
    $this->pluginManagerSiteimproveDomain = $pluginManagerSiteimproveDomain;
    $this->messenger = $messenger;
    $this->httpClient = $httpClient;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    // Instantiates this form class.
    return new static($container
      ->get('config.factory'), $container
      ->get('siteimprove.utils'), $container
      ->get('plugin.manager.siteimprove_domain'), $container
      ->get('messenger'), $container
      ->get('http_client'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('siteimprove.settings');
    $form['container'] = [
      '#title' => $this
        ->t('Token'),
      '#type' => 'fieldset',
    ];
    $form['container']['token'] = [
      '#default_value' => $config
        ->get('token'),
      '#description' => $this
        ->t('Configure Siteimprove Plugin token.'),
      '#maxlength' => 50,
      '#prefix' => '<div id="token-wrapper">',
      '#required' => TRUE,
      '#size' => 50,
      '#suffix' => '</div>',
      '#title' => $this
        ->t('Token'),
      '#type' => 'textfield',
    ];
    $form['container']['request_new_token'] = [
      '#ajax' => [
        'callback' => '::requestToken',
        'wrapper' => 'token-wrapper',
      ],
      '#limit_validation_errors' => [],
      '#type' => 'button',
      '#value' => $this
        ->t('Request new token'),
    ];
    $plugins = $this->pluginManagerSiteimproveDomain
      ->getDefinitions();
    $plugin_definitions = [];
    $options = [];
    foreach ($plugins as $plugin) {
      $options[$plugin['id']] = $plugin['label'];
      $plugin_definitions[$plugin['id']] = $plugin;
    }
    $form['domain'] = [
      '#title' => $this
        ->t('Frontend domain'),
      '#type' => 'fieldset',
    ];
    $form['domain']['domain_plugin'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Siteimprove Domain Plugins'),
      '#description' => $this
        ->t('Choose which Siteimprove Domain plugin to use'),
      '#options' => $options,
      '#size' => 1,
      '#default_value' => $config
        ->get('domain_plugin_id'),
      '#weight' => '0',
    ];
    foreach ($options as $key => $option) {

      /** @var \Drupal\siteimprove\Plugin\SiteimproveDomainBase $plugin */
      $plugin_definition = $plugin_definitions[$key];
      $plugin = $this->pluginManagerSiteimproveDomain
        ->createInstance($plugin_definition['id']);
      $plugin
        ->buildForm($form, $form_state, $plugin_definition);
      $form[$plugin_definition['id']]['#states']['visible'] = [
        ':input[name="domain_plugin"]' => [
          'value' => $plugin_definition['id'],
        ],
      ];
      $form['domain'][$plugin_definition['id']] = [
        '#type' => 'markup',
        '#markup' => '<strong>' . $plugin_definition['label'] . '</strong><br />' . $plugin_definition['description'],
        '#prefix' => '<div name="' . $plugin_definition['id'] . '_description' . '">',
        '#suffix' => '</div>',
      ];
    }
    $form['prepublish'] = [
      '#title' => $this
        ->t('Prepublish check'),
      '#type' => 'fieldset',
    ];
    $form['prepublish']['description'] = [
      '#markup' => "<p>" . $this
        ->t("When this is enabled, it's possible to perform a SiteImprove prepublish check when editing content, before publishing content.") . "</p>",
    ];
    $form['prepublish']['prepublish_enabled'] = [
      '#title' => $this
        ->t('Enable prepublish check'),
      '#type' => 'checkbox',
      '#default_value' => $config
        ->get('prepublish_enabled'),
    ];
    $form['prepublish']['api_username'] = [
      '#type' => 'textfield',
      '#description' => 'SiteImprove API username',
      '#default_value' => $config
        ->get('api_username'),
      '#states' => [
        'enabled' => [
          ':input[name="prepublish_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['prepublish']['api_key'] = [
      '#type' => 'textfield',
      '#description' => 'SiteImprove API key',
      '#default_value' => $config
        ->get('api_key'),
      '#states' => [
        'enabled' => [
          ':input[name="prepublish_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    if ($config
      ->get('prepublish_enabled')) {

      // Check API if prepublish checking has been enabled.
      $url = 'https://api.siteimprove.com/v2/settings/content_checking';
      $res = $this->httpClient
        ->request('GET', $url, [
        'auth' => [
          $config
            ->get('api_username'),
          $config
            ->get('api_key'),
        ],
        'headers' => [
          'Accept' => 'application/json',
        ],
        'http_errors' => FALSE,
      ]);
      $form['prepublish']['api'] = [
        '#type' => 'fieldset',
        '#title' => $this
          ->t('Siteimprove API response'),
        '#states' => [
          'visible' => [
            ':input[name="prepublish_enabled"]' => [
              'checked' => TRUE,
            ],
          ],
        ],
      ];

      // Only treat http status code 200 as successful.
      if ($res
        ->getStatusCode() == 200) {
        $form['#attached']['library'][] = 'siteimprove/siteimprove.settings';
        $result = Json::decode($res
          ->getBody());
        if (isset($result['is_ready']) && $result['is_ready']) {
          $form['prepublish']['api']['is_ready'] = [
            '#type' => 'markup',
            '#markup' => '<p><span class="prepublish-is-ready">' . $this
              ->t('Prepublish check has been enabled') . '</span></p>',
          ];
        }
        else {
          $form['prepublish']['api']['is_ready'] = [
            '#type' => 'markup',
            '#markup' => '<p><span class="prepublish-is-not-ready">' . $this
              ->t('Prepublish check has not been enabled yet in Siteimprove. This can take several minutes. Check back later.') . '</span></p>',
          ];

          // Enable republish feature in Siteimprove.
          $this
            ->setRepublish($config
            ->get('api_username'), $config
            ->get('api_key'));
        }
      }
      else {

        // Treat all other http status codes as errors.
        $form['prepublish']['api']['error'] = [
          '#type' => 'markup',
          '#markup' => '<p><span>' . $this
            ->t('There were problems contacting the API - see error below. Check your username and API key.') . '</span></p>' . '<p>HTTP status: <strong>' . $res
            ->getStatusCode() . ' ' . $res
            ->getReasonPhrase() . '</strong></p>',
        ];
      }
    }
    $form['prepublish']['content_types'] = [
      '#type' => 'fieldset',
      '#title' => 'Enabled content types',
      '#states' => [
        'visible' => [
          ':input[name="prepublish_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $options = node_type_get_names();
    $form['prepublish']['content_types']['enabled_content_types'] = [
      '#type' => 'checkboxes',
      '#options' => $options,
      '#default_value' => $config
        ->get('enabled_content_types'),
      '#title' => $this
        ->t('Select prepublish check enabled content types'),
      '#description' => $this
        ->t('Select which content types Siteimprove Prepublish check is enabled for'),
    ];
    $form['prepublish']['taxonomies'] = [
      '#type' => 'fieldset',
      '#title' => 'Enabled taxonomies',
      '#states' => [
        'visible' => [
          ':input[name="prepublish_enabled"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $vocabulary_names = taxonomy_vocabulary_get_names();
    $vocabularies = Vocabulary::loadMultiple($vocabulary_names);
    $taxonomy_options = [];
    foreach ($vocabularies as $vocabulary) {
      $taxonomy_options[$vocabulary
        ->id()] = $vocabulary
        ->label();
    }
    $form['prepublish']['taxonomies']['enabled_taxonomies'] = [
      '#type' => 'checkboxes',
      '#options' => $taxonomy_options,
      '#default_value' => $config
        ->get('enabled_taxonomies'),
      '#title' => $this
        ->t('Select prepublish check enabled taxonomies'),
      '#description' => $this
        ->t('Select which taxonomies Siteimprove Prepublish check is enabled for'),
    ];

    // Invalidate siteimprove_toolbar cache tag to ensure that the toolbar's
    // cache is properly invalidated.
    Cache::invalidateTags([
      'siteimprove_toolbar',
    ]);
    return parent::buildForm($form, $form_state);
  }

  /**
   * Enable Siteimprove's Republish feature on Siteimprove server.
   *
   * @param string $username
   *   API username.
   * @param string $key
   *   API key.
   */
  protected function setRepublish($username, $key) {
    $url = 'https://api.siteimprove.com/v2/settings/content_checking';
    $res = $this->httpClient
      ->request('POST', $url, [
      'auth' => [
        $username,
        $key,
      ],
      'headers' => [
        'Accept' => 'application/json',
      ],
      'http_errors' => FALSE,
    ]);
  }

  /**
   * Implements callback for Ajax event on token request.
   *
   * @param array $form
   *   From render array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Current state of form.
   *
   * @return array
   *   Token field with value filled.
   */
  public function requestToken(array &$form, FormStateInterface &$form_state) {

    // Request new token.
    if ($token = $this->siteimprove
      ->requestToken()) {
      $form['container']['token']['#value'] = $token;
    }
    else {
      $this->messenger
        ->addError($this
        ->t('There was an error requesting a new token. Please try again in a few minutes.'));
    }
    $form_state
      ->setRebuild(TRUE);
    return $form['container']['token'];
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    $domain_plugin = $form_state
      ->getValue('domain_plugin');
    $plugin = $this->pluginManagerSiteimproveDomain
      ->createInstance($domain_plugin);
    $plugin
      ->validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $domain_plugin = $form_state
      ->getValue('domain_plugin');
    $this
      ->config('siteimprove.settings')
      ->set('token', $form_state
      ->getValue('token'))
      ->set('domain_plugin_id', $domain_plugin)
      ->set('prepublish_enabled', $form_state
      ->getValue('prepublish_enabled'))
      ->set('api_username', $form_state
      ->getValue('api_username'))
      ->set('api_key', $form_state
      ->getValue('api_key'))
      ->set('enabled_content_types', $form_state
      ->getValue('enabled_content_types'))
      ->set('enabled_taxonomies', $form_state
      ->getValue('enabled_taxonomies'))
      ->save();
    $plugin = $this->pluginManagerSiteimproveDomain
      ->createInstance($domain_plugin);
    $plugin
      ->submitForm($form, $form_state);
  }

}

Members

Name	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	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.
SettingsForm::$httpClient	protected	property	Drupal built-in HTTP client service.
SettingsForm::$messenger	protected	property	Drupal Core Messenger service. Overrides MessengerTrait::$messenger
SettingsForm::$pluginManagerSiteimproveDomain	protected	property	Drupal\siteimprove\Plugin\SiteimproveDomainManager definition.
SettingsForm::$siteimprove	protected	property	SiteimproveUtils var.
SettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
SettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
SettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
SettingsForm::requestToken	public	function	Implements callback for Ajax event on token request.
SettingsForm::setRepublish	protected	function	Enable Siteimprove's Republish feature on Siteimprove server.
SettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
SettingsForm::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
SettingsForm::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object. Overrides ConfigFormBase::__construct
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 SettingsForm in Siteimprove 8

Hierarchy

File

Namespace

Members

API Navigation