SimpletestSettingsForm.php in Zircon Profile 8

Contains \Drupal\simpletest\Form\SimpletestSettingsForm.

Namespace

Drupal\simpletest\Form

File

core/modules/simpletest/src/Form/SimpletestSettingsForm.php

<?php

/**
 * @file
 * Contains \Drupal\simpletest\Form\SimpletestSettingsForm.
 */
namespace Drupal\simpletest\Form;

use Drupal\Core\Form\ConfigFormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Configure simpletest settings for this site.
 */
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'] = array(
      '#type' => 'details',
      '#title' => $this
        ->t('General'),
      '#open' => TRUE,
    );
    $form['general']['simpletest_clear_results'] = array(
      '#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'] = array(
      '#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'] = array(
      '#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'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Method'),
      '#options' => array(
        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'] = array(
      '#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'] = array(
      '#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);
  }

}

Classes

Name	Description
SimpletestSettingsForm	Configure simpletest settings for this site.