You are here

Home » API reference » Double Field 8.3 » FieldTypeTest.php

final class FieldTypeTest in Double Field 8.3

Same name and namespace in other branches
  1. 4.x tests/src/Functional/FieldTypeTest.php \Drupal\Tests\double_field\Functional\FieldTypeTest

A test for Double Field type.

@group double_field

Hierarchy

Expanded class hierarchy of FieldTypeTest

File

tests/src/Functional/FieldTypeTest.php, line 12

Namespace

Drupal\Tests\double_field\Functional
View source 
final class FieldTypeTest extends TestBase {

  /**
   * Test field storage settings.
   */
  public function testFieldStorageSettings() : void {

    // Not random to avoid different plural form in messages.
    $maxlength = 50;

    // -- Boolean and varchar.
    $storage_settings['storage']['first']['type'] = 'boolean';
    $storage_settings['storage']['second']['type'] = 'string';
    $storage_settings['storage']['second']['maxlength'] = $maxlength;
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      // The valid boolean value is 0 or 1.
      2,
      $this
        ->randomString($maxlength + 1),
    ];
    $expected_messages = [
      'This value should be of the correct primitive type.',
      new FormattableMarkup('This value is too long. It should have @maxlength characters or less.', [
        '@maxlength' => $maxlength,
      ]),
    ];
    $this
      ->assertViolations($values, $expected_messages);

    // Set the field optional as zero value will cause 'No blank' violation.
    $settings['first']['required'] = FALSE;
    $this
      ->saveFieldSettings($settings);
    $values = [
      mt_rand(0, 1),
      $this
        ->randomString($maxlength),
    ];
    $this
      ->assertNoViolations($values);

    // -- Text (long) and integer.
    $storage_settings['storage']['first']['type'] = 'text';
    $storage_settings['storage']['second']['type'] = 'integer';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      // Text storage has no restrictions.
      $this
        ->randomString(1000),
      // Float value should not be accepted.
      123.456,
    ];
    $expected_messages = [
      'This value should be of the correct primitive type.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      $this
        ->randomString(1000),
      mt_rand(0, 1000),
    ];
    $this
      ->assertNoViolations($values);

    // -- Float and numeric.
    $storage_settings['storage']['first']['type'] = 'float';
    $storage_settings['storage']['second']['type'] = 'numeric';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      'abc',
      'abc',
    ];
    $expected_messages = [
      'This value should be of the correct primitive type.',
      'This value should be of the correct primitive type.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      mt_rand(0, 1000) + mt_rand(),
      mt_rand(0, 1000) + mt_rand(),
    ];
    $this
      ->assertNoViolations($values);

    // -- Email and URI.
    $storage_settings['storage']['first']['type'] = 'email';
    $storage_settings['storage']['second']['type'] = 'uri';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      'abc',
      'abc',
    ];
    $expected_messages = [
      'This value is not a valid email address.',
      'This value should be of the correct primitive type.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      'qwe@rty.ui',
      'http://example.com',
    ];
    $this
      ->assertNoViolations($values);

    // -- Datetime.
    $storage_settings['storage']['first']['type'] = 'datetime_iso8601';
    $storage_settings['storage']['second']['type'] = 'string';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      'abc',
      'abc',
    ];
    $expected_messages = [
      'This value should be of the correct primitive type.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      '2017-10-10T01:00:00',
      'abc',
    ];
    $this
      ->assertNoViolations($values);
  }

  /**
   * Test field storage settings form.
   */
  public function testFieldStorageSettingsForm() : void {
    $this
      ->drupalGet($this->fieldStorageAdminPath);
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $prefix = sprintf('//form//details[@id = "edit-settings-storage-%s"]', $subfield);
      $select_prefix = $prefix . "//select[@name = 'settings[storage][{$subfield}][type]' and count(option) = 10]";
      $this
        ->assertXpath($select_prefix . '/option[@value = "boolean" and text() = "Boolean"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "string" and text() = "Text"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "text" and text() = "Text (long)"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "integer" and text() = "Integer"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "float" and text() = "Float"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "numeric" and text() = "Decimal"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "email" and text() = "Email"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "telephone" and text() = "Telephone"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "datetime_iso8601" and text() = "Date"]');
      $this
        ->assertXpath($select_prefix . '/option[@value = "uri" and text() = "Url"]');
      $this
        ->assertXpath($prefix . "//input[@name = 'settings[storage][{$subfield}][maxlength]' and @value = 50]");
      $this
        ->assertXpath($prefix . "//input[@name = 'settings[storage][{$subfield}][precision]' and @value = 10]");
      $this
        ->assertXpath($prefix . "//input[@name = 'settings[storage][{$subfield}][scale]' and @value = 2]");
      $datetime_xpath = '//input[@value = "datetime"]/following-sibling::label[text() = "Date and time"]';
      $date_xpath = '//input[@value = "date"]/following-sibling::label[text() = "Date only"]';
      $this
        ->assertXpath(sprintf('//fieldset/legend[span[text() = "Date type"]]/following-sibling::div[%s and %s]', $datetime_xpath, $date_xpath));
    }

    // Submit some example settings and check if they are accepted.
    $edit = [
      'settings[storage][first][type]' => 'string',
      'settings[storage][first][maxlength]' => 15,
      'settings[storage][second][type]' => 'numeric',
      'settings[storage][second][precision]' => 30,
      'settings[storage][second][scale]' => 5,
    ];
    $this
      ->drupalPostForm($this->fieldStorageAdminPath, $edit, 'Save field settings');
    $message = new FormattableMarkup('Updated field %field_name field settings.', [
      '%field_name' => $this->fieldName,
    ]);
    $this
      ->assertStatusMessage($message);
    $this
      ->assertWarningMessage('Since storage type has been changed you need to verify configuration of related widget on manage form display page.');
    $this
      ->drupalGet($this->fieldStorageAdminPath);
    $this
      ->assertXpath('//select[@name = "settings[storage][first][type]"]/option[@selected = "selected" and @value = "string"]');
    $this
      ->assertXpath('//input[@name = "settings[storage][first][maxlength]" and @value = 15]');
    $this
      ->assertXpath('//select[@name = "settings[storage][second][type]"]/option[@selected = "selected" and @value = "numeric"]');
    $this
      ->assertXpath('//input[@name = "settings[storage][second][precision]" and @value = 30]');
    $this
      ->assertXpath('//input[@name = "settings[storage][second][scale]" and @value = 5]');
  }

  /**
   * Test field settings.
   */
  public function testFieldSettings() : void {

    // -- Boolean and string.
    $storage_settings['storage']['first']['type'] = 'boolean';
    $storage_settings['storage']['second']['type'] = 'string';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $settings['second']['list'] = TRUE;
    $settings['second']['allowed_values'] = [
      'aaa' => 'Aaa',
      'bbb' => 'Bbb',
      'ccc' => 'Ccc',
    ];
    $this
      ->saveFieldSettings($settings);
    $expected_messages = [
      'The value you selected is not a valid choice.',
    ];
    $this
      ->assertViolations([
      1,
      'abc',
    ], $expected_messages);
    $values = [
      // Boolean has no field level settings that may cause violations.
      1,
      array_rand($settings['second']['allowed_values']),
    ];
    $this
      ->assertNoViolations($values);

    // -- Integer.
    $storage_settings['storage']['first']['type'] = 'integer';
    $storage_settings['storage']['second']['type'] = 'integer';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $min_limit = mt_rand(-1000, 1000);
    $max_limit = mt_rand($min_limit, $min_limit + 1000);
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $settings[$subfield]['list'] = FALSE;
      $settings[$subfield]['min'] = $min_limit;
      $settings[$subfield]['max'] = $max_limit;
    }
    $this
      ->saveFieldSettings($settings);
    $values = [
      $min_limit - 1,
      $max_limit + 1,
    ];
    $expected_messages = [
      new FormattableMarkup('This value should be @min_limit or more.', [
        '@min_limit' => $min_limit,
      ]),
      new FormattableMarkup('This value should be @max_limit or less.', [
        '@max_limit' => $max_limit,
      ]),
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      mt_rand($min_limit, $max_limit),
      mt_rand($min_limit, $max_limit),
    ];
    $this
      ->assertNoViolations($values);

    // -- Float and numeric.
    $storage_settings['storage']['first']['type'] = 'float';
    $storage_settings['storage']['second']['type'] = 'numeric';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $min_limit = mt_rand(-1000, 1000);
    $max_limit = mt_rand($min_limit, $min_limit + 1000);
    $settings = $this->field
      ->getSettings();
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $settings[$subfield]['list'] = FALSE;
      $settings[$subfield]['min'] = $min_limit;
      $settings[$subfield]['max'] = $max_limit;
    }
    $this
      ->saveFieldSettings($settings);
    $values = [
      $min_limit - mt_rand(1, 100),
      $max_limit + mt_rand(1, 100),
    ];
    $expected_messages = [
      new FormattableMarkup('This value should be @min_limit or more.', [
        '@min_limit' => $min_limit,
      ]),
      new FormattableMarkup('This value should be @max_limit or less.', [
        '@max_limit' => $max_limit,
      ]),
    ];
    $this
      ->assertViolations($values, $expected_messages);

    // Test allowed values.
    $settings['first']['list'] = TRUE;
    $settings['first']['allowed_values'] = [
      '-12.379' => 'Aaa',
      '4565' => 'Bbb',
      '93577285' => 'Ccc',
    ];
    $settings['second']['list'] = TRUE;
    $settings['second']['allowed_values'] = [
      '-245' => 'Aaa',
      'sssssss' => 'Bbb',
      '7738854' => 'Ccc',
    ];
    $settings['second']['max'] = $max_limit;
    $this
      ->saveFieldSettings($settings);
    $values = [
      123.356,
      300.12,
    ];
    $expected_messages = [
      'The value you selected is not a valid choice.',
      'The value you selected is not a valid choice.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $this
      ->assertNoViolations([
      4565,
      7738854,
    ]);

    // -- Email and telephone.
    $storage_settings['storage']['first']['type'] = 'email';
    $storage_settings['storage']['second']['type'] = 'telephone';
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $settings[$subfield]['list'] = FALSE;
    }
    $this
      ->saveFieldSettings($settings);
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      'aaa',
      str_repeat('x', 51),
    ];
    $expected_messages = [
      'This value is not a valid email address.',
      'This value is too long. It should have 50 characters or less.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      'abc@example.com',
      str_repeat('x', 50),
    ];
    $this
      ->assertNoViolations($values);

    // -- Uri and date.
    $storage_settings['storage']['first']['type'] = 'uri';
    $storage_settings['storage']['second']['type'] = 'datetime_iso8601';
    foreach ([
      'first',
      'second',
    ] as $subfield) {
      $settings[$subfield]['list'] = FALSE;
    }
    $this
      ->saveFieldSettings($settings);
    $this
      ->saveFieldStorageSettings($storage_settings);
    $values = [
      'aaa',
      'bbb',
    ];
    $expected_messages = [
      'This value should be of the correct primitive type.',
      'This value should be of the correct primitive type.',
    ];
    $this
      ->assertViolations($values, $expected_messages);
    $values = [
      'http://example.com',
      '2016-10-11T01:12:14',
    ];
    $this
      ->assertNoViolations($values);
  }

  /**
   * Test field settings form.
   */
  public function testFieldSettingsForm() : void {

    // -- Boolean and string.
    $storage_settings['storage']['first']['type'] = 'boolean';
    $storage_settings['storage']['second']['type'] = 'string';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//details[@id = "edit-settings-first"]/summary[text() = "First subfield - Boolean"]');
    $this
      ->assertXpath('//input[@name = "settings[first][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][required]" and @checked = "checked"]');
    $this
      ->assertNoXpath('//input[@name = "settings[first][list]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][on_label]" and @value = "On"]');
    $this
      ->assertXpath('//input[@name = "settings[first][off_label]" and @value = "Off"]');
    $this
      ->assertXpath('//details[@id = "edit-settings-second"]/summary[text() = "Second subfield - Text"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[second][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[second][allowed_values]"]');

    // -- Text and email.
    $storage_settings['storage']['first']['type'] = 'text';
    $storage_settings['storage']['second']['type'] = 'email';

    // SQLite database gets locked here by some reason.
    usleep(2500);
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//details[@id = "edit-settings-first"]/summary[text() = "First subfield - Text (long)"]');
    $this
      ->assertXpath('//input[@name = "settings[first][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][required]" and @checked = "checked"]');
    $this
      ->assertNoXpath('//input[@name = "settings[first][list]"]');
    $this
      ->assertNoXpath('//textarea[@name = "settings[first][allowed_values]"]');
    $this
      ->assertXpath('//details[@id = "edit-settings-second"]/summary[text() = "Second subfield - Email"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[second][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[second][allowed_values]"]');

    // -- Telephone and URL.
    $storage_settings['storage']['first']['type'] = 'telephone';
    $storage_settings['storage']['second']['type'] = 'uri';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//details[@id = "edit-settings-first"]/summary[text() = "First subfield - Telephone"]');
    $this
      ->assertXpath('//input[@name = "settings[first][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[first][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[first][allowed_values]"]');
    $this
      ->assertXpath('//details[@id = "edit-settings-second"]/summary[text() = "Second subfield - Url"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[second][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[second][allowed_values]"]');

    // -- Date and integer.
    $storage_settings['storage']['first']['type'] = 'datetime_iso8601';
    $storage_settings['storage']['second']['type'] = 'integer';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//details[@id = "edit-settings-first"]/summary[text() = "First subfield - Date"]');
    $this
      ->assertXpath('//input[@name = "settings[first][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[first][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[first][allowed_values]"]');
    $this
      ->assertXpath('//details[@id = "edit-settings-second"]/summary[text() = "Second subfield - Integer"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[second][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[second][allowed_values]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][min]" and @type = "number"]');
    $this
      ->assertXpath('//input[@name = "settings[second][max]" and @type = "number"]');

    // -- Float and decimal.
    $storage_settings['storage']['first']['type'] = 'float';
    $storage_settings['storage']['second']['type'] = 'numeric';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//details[@id = "edit-settings-first"]/summary[text() = "First subfield - Float"]');
    $this
      ->assertXpath('//input[@name = "settings[first][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[first][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[first][allowed_values]"]');
    $this
      ->assertXpath('//input[@name = "settings[first][min]" and @type = "number"]');
    $this
      ->assertXpath('//input[@name = "settings[first][max]" and @type = "number"]');
    $this
      ->assertXpath('//details[@id = "edit-settings-second"]/summary[text() = "Second subfield - Decimal"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][required]" and @checked = "checked"]');
    $this
      ->assertXpath('//input[@name = "settings[second][list]" and not(@checked)]');
    $this
      ->assertXpath('//textarea[@name = "settings[second][allowed_values]"]');
    $this
      ->assertXpath('//input[@name = "settings[second][min]" and @type = "number"]');
    $this
      ->assertXpath('//input[@name = "settings[second][max]" and @type = "number"]');

    // Submit some example settings and check whether they are accepted.
    $edit = [
      'settings[first][label]' => 'First',
      'settings[first][list]' => 1,
      'settings[first][allowed_values]' => '123|Aaa',
      'settings[second][label]' => 'Second',
      'settings[second][min]' => 10,
      'settings[second][max]' => 20,
    ];
    $this
      ->drupalPostForm(NULL, $edit, 'Save settings');
    $this
      ->drupalGet($this->fieldAdminPath);
    $this
      ->assertXpath('//input[@name = "settings[first][label]" and @value = "First"]');
    $this
      ->assertXpath('//input[@name = "settings[first][list]" and @checked = "checked"]');
    $this
      ->assertXpath('//textarea[@name = "settings[first][allowed_values]" and text() = "123|Aaa"]');
    $this
      ->assertXpath('//input[@name = "settings[second][label]" and @value = "Second"]');
    $this
      ->assertXpath('//input[@name = "settings[second][min]" and @value = 10]');
    $this
      ->assertXpath('//input[@name = "settings[second][max]" and @value = 20]');
  }

  /**
   * Test allowed values validation.
   */
  public function testAllowedValuesValidation() : void {

    // --
    $maxlength = 50;
    $storage_settings['storage']['first']['type'] = 'string';
    $storage_settings['storage']['first']['maxlength'] = $maxlength;
    $storage_settings['storage']['second']['type'] = 'float';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $edit = [
      'settings[first][list]' => 1,
      // Random sting may content '|' character.
      'settings[first][allowed_values]' => str_repeat('a', $maxlength + 1),
      'settings[second][list]' => 1,
      'settings[second][allowed_values]' => implode("\n", [
        123,
        'abc',
        789,
      ]),
    ];
    $this
      ->drupalPostForm($this->fieldAdminPath, $edit, 'Save settings');
    $this
      ->assertErrorMessage(new FormattableMarkup('Allowed values list: each key must be a string at most @maxlength characters long.', [
      '@maxlength' => $maxlength,
    ]));
    $this
      ->assertErrorMessage('Allowed values list: each key must be a valid integer or decimal.');
    $edit = [
      'settings[first][allowed_values]' => str_repeat('a', $maxlength),
      'settings[second][allowed_values]' => implode("\n", [
        123,
        456,
        789,
      ]),
    ];
    $this
      ->drupalPostForm($this->fieldAdminPath, $edit, 'Save settings');
    self::assertCount(0, $this
      ->getMessages('error'), 'No error messages were found.');
    $this
      ->assertStatusMessage(new FormattableMarkup('Saved %field_name configuration.', [
      '%field_name' => $this->fieldName,
    ]));

    // --
    $storage_settings['storage']['first']['type'] = 'integer';
    $storage_settings['storage']['second']['type'] = 'numeric';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $edit = [
      'settings[first][allowed_values]' => implode("\n", [
        123,
        'abc',
        789,
      ]),
      'settings[second][allowed_values]' => implode("\n", [
        123,
        'abc',
        789,
      ]),
    ];
    $this
      ->drupalPostForm($this->fieldAdminPath, $edit, 'Save settings');
    $this
      ->assertErrorMessage('Allowed values list: keys must be integers.');
    $this
      ->assertErrorMessage('Allowed values list: each key must be a valid integer or decimal.');
    $edit = [
      'settings[first][allowed_values]' => implode("\n", [
        123,
        456,
        789,
      ]),
      'settings[second][allowed_values]' => implode("\n", [
        123,
        456,
        789,
      ]),
    ];
    $this
      ->drupalPostForm($this->fieldAdminPath, $edit, 'Save settings');
    self::assertCount(0, $this
      ->getMessages('error'), 'No error messages were found.');
    $this
      ->assertStatusMessage(new FormattableMarkup('Saved %field_name configuration.', [
      '%field_name' => $this->fieldName,
    ]));
  }

  /**
   * Test required options.
   */
  public function testRequiredOptions() : void {
    $storage_settings['storage']['first']['type'] = 'integer';
    $storage_settings['storage']['second']['type'] = 'boolean';
    $this
      ->saveFieldStorageSettings($storage_settings);
    $this
      ->assertViolations([
      NULL,
      1,
    ], [
      'This value should not be blank.',
    ]);

    // Zero should be treated as not empty value.
    $this
      ->assertNoViolations([
      0,
      1,
    ]);
    $settings['first']['required'] = FALSE;
    $this
      ->saveFieldSettings($settings);
    $this
      ->assertNoViolations([
      NULL,
      1,
    ]);

    // For boolean field zero is an empty value.
    $this
      ->assertViolations([
      123,
      0,
    ], [
      'This value should not be blank.',
    ]);
    $settings['second']['required'] = FALSE;
    $this
      ->saveFieldSettings($settings);
    $this
      ->assertNoViolations([
      123,
      0,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FieldTypeTest::testAllowedValuesValidation public function Test allowed values validation.
FieldTypeTest::testFieldSettings public function Test field settings.
FieldTypeTest::testFieldSettingsForm public function Test field settings form.
FieldTypeTest::testFieldStorageSettings public function Test field storage settings.
FieldTypeTest::testFieldStorageSettingsForm public function Test field storage settings form.
FieldTypeTest::testRequiredOptions public function Test required options.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestBase::$contentTypeId protected property A content type id.
TestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
TestBase::$field protected property Field instance.
TestBase::$fieldAdminPath protected property A path to field settings form.
TestBase::$fieldName protected property A field name used for testing.
TestBase::$fieldStorage protected property Field storage instance.
TestBase::$fieldStorageAdminPath protected property A path to field storage settings form.
TestBase::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
TestBase::assertErrorMessage protected function Passes if a given error message was found on the page.
TestBase::assertNoViolations protected function Passes if no violations were found.
TestBase::assertNoXpath protected function Checks that an element does not exist on the current page.
TestBase::assertStatusMessage protected function Passes if a given status message was found on the page.
TestBase::assertViolations protected function Passes if all expected violations were found.
TestBase::assertWarningMessage protected function Passes if a given warning message was found on the page.
TestBase::assertXpath protected function Checks that an element exists on the current page.
TestBase::getMessages protected function Finds Drupal messages on the page.
TestBase::saveFieldSettings protected function Saves field settings.
TestBase::saveFieldStorageSettings protected function Saves storage settings.
TestBase::saveFormatterSettings protected function Saves formatter settings.
TestBase::saveWidgetSettings protected function Saves widget settings.
TestBase::setUp protected function Overrides BrowserTestBase::setUp 1
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.