You are here

Home » API reference » Drupal 8 » SimpletestSettingsForm.php

class SimpletestSettingsForm in Drupal 8

Configure simpletest settings for this site.

@internal

Hierarchy

Expanded class hierarchy of SimpletestSettingsForm

1 string reference to 'SimpletestSettingsForm'
simpletest.routing.yml in core/modules/simpletest/simpletest.routing.yml
core/modules/simpletest/simpletest.routing.yml

File

core/modules/simpletest/src/Form/SimpletestSettingsForm.php, line 13

Namespace

Drupal\simpletest\Form
View source 
class SimpletestSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config('simpletest.settings');
    $form['general'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('General'),
      '#open' => TRUE,
    ];
    $form['general']['simpletest_clear_results'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Clear results after each complete test suite run'),
      '#description' => $this
        ->t('By default SimpleTest will clear the results after they have been viewed on the results page, but in some cases it may be useful to leave the results in the database. The results can then be viewed at <em>admin/config/development/testing/results/[test_id]</em>. The test ID can be found in the database, simpletest table, or kept track of when viewing the results the first time. Additionally, some modules may provide more analysis or features that require this setting to be disabled.'),
      '#default_value' => $config
        ->get('clear_results'),
    ];
    $form['general']['simpletest_verbose'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Provide verbose information when running tests'),
      '#description' => $this
        ->t('The verbose data will be printed along with the standard assertions and is useful for debugging. The verbose data will be erased between each test suite run. The verbose data output is very detailed and should only be used when debugging.'),
      '#default_value' => $config
        ->get('verbose'),
    ];
    $form['httpauth'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('HTTP authentication'),
      '#description' => $this
        ->t('HTTP auth settings to be used by the SimpleTest browser during testing. Useful when the site requires basic HTTP authentication.'),
    ];
    $form['httpauth']['simpletest_httpauth_method'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Method'),
      '#options' => [
        CURLAUTH_BASIC => $this
          ->t('Basic'),
        CURLAUTH_DIGEST => $this
          ->t('Digest'),
        CURLAUTH_GSSNEGOTIATE => $this
          ->t('GSS negotiate'),
        CURLAUTH_NTLM => $this
          ->t('NTLM'),
        CURLAUTH_ANY => $this
          ->t('Any'),
        CURLAUTH_ANYSAFE => $this
          ->t('Any safe'),
      ],
      '#default_value' => $config
        ->get('httpauth.method'),
    ];
    $username = $config
      ->get('httpauth.username');
    $password = $config
      ->get('httpauth.password');
    $form['httpauth']['simpletest_httpauth_username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username'),
      '#default_value' => $username,
    ];
    if (!empty($username) && !empty($password)) {
      $form['httpauth']['simpletest_httpauth_username']['#description'] = $this
        ->t('Leave this blank to delete both the existing username and password.');
    }
    $form['httpauth']['simpletest_httpauth_password'] = [
      '#type' => 'password',
      '#title' => $this
        ->t('Password'),
    ];
    if ($password) {
      $form['httpauth']['simpletest_httpauth_password']['#description'] = $this
        ->t('To change the password, enter the new password here.');
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $config = $this
      ->config('simpletest.settings');

    // If a username was provided but a password wasn't, preserve the existing
    // password.
    if (!$form_state
      ->isValueEmpty('simpletest_httpauth_username') && $form_state
      ->isValueEmpty('simpletest_httpauth_password')) {
      $form_state
        ->setValue('simpletest_httpauth_password', $config
        ->get('httpauth.password'));
    }

    // If a password was provided but a username wasn't, the credentials are
    // incorrect, so throw an error.
    if ($form_state
      ->isValueEmpty('simpletest_httpauth_username') && !$form_state
      ->isValueEmpty('simpletest_httpauth_password')) {
      $form_state
        ->setErrorByName('simpletest_httpauth_username', $this
        ->t('HTTP authentication credentials must include a username in addition to a password.'));
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $this
      ->config('simpletest.settings')
      ->set('clear_results', $form_state
      ->getValue('simpletest_clear_results'))
      ->set('verbose', $form_state
      ->getValue('simpletest_verbose'))
      ->set('httpauth.method', $form_state
      ->getValue('simpletest_httpauth_method'))
      ->set('httpauth.username', $form_state
      ->getValue('simpletest_httpauth_username'))
      ->set('httpauth.password', $form_state
      ->getValue('simpletest_httpauth_password'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

Members

Namesort descending 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.
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.
SimpletestSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
SimpletestSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
SimpletestSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
SimpletestSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
SimpletestSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.