class DateTimeFieldTest in Drupal 9

Tests Datetime field functionality.

@group datetime

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\datetime\Functional\DateTestBase
    • class \Drupal\Tests\datetime\Functional\DateTimeFieldTest

File

core/modules/datetime/tests/src/Functional/DateTimeFieldTest.php, line 19

Namespace

Drupal\Tests\datetime\Functional

class DateTimeFieldTest extends DateTestBase {

  /**
   * The default display settings to use for the formatters.
   *
   * @var array
   */
  protected $defaultSettings = [
    'timezone_override' => '',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'classy';

  /**
   * {@inheritdoc}
   */
  protected function getTestFieldType() {
    return 'datetime';
  }

  /**
   * Tests date field functionality.
   */
  public function testDateField() {
    $field_name = $this->fieldStorage
      ->getName();
    $display_repository = \Drupal::service('entity_display.repository');

    // Loop through defined timezones to test that date-only fields work at the
    // extremes.
    foreach (static::$timezones as $timezone) {
      $this
        ->setSiteTimezone($timezone);
      $this
        ->assertEquals($timezone, $this
        ->config('system.date')
        ->get('timezone.default'), 'Time zone set to ' . $timezone);

      // Display creation form.
      $this
        ->drupalGet('entity_test/add');
      $this
        ->assertSession()
        ->fieldValueEquals("{$field_name}[0][value][date]", '');
      $this
        ->assertSession()
        ->elementExists('xpath', '//*[@id="edit-' . $field_name . '-wrapper"]//label[contains(@class,"js-form-required")]');
      $this
        ->assertSession()
        ->fieldNotExists("{$field_name}[0][value][time]");

      // ARIA described-by.
      $this
        ->assertSession()
        ->elementExists('xpath', '//input[@aria-describedby="edit-' . $field_name . '-0-value--description"]');
      $this
        ->assertSession()
        ->elementExists('xpath', '//div[@id="edit-' . $field_name . '-0-value--description"]');

      // Build up a date in the UTC timezone. Note that using this will also
      // mimic the user in a different timezone simply entering '2012-12-31' via
      // the UI.
      $value = '2012-12-31 00:00:00';
      $date = new DrupalDateTime($value, DateTimeItemInterface::STORAGE_TIMEZONE);

      // Submit a valid date and ensure it is accepted.
      $date_format = DateFormat::load('html_date')
        ->getPattern();
      $time_format = DateFormat::load('html_time')
        ->getPattern();
      $edit = [
        "{$field_name}[0][value][date]" => $date
          ->format($date_format),
      ];
      $this
        ->submitForm($edit, 'Save');
      preg_match('|entity_test/manage/(\\d+)|', $this
        ->getUrl(), $match);
      $id = $match[1];
      $this
        ->assertSession()
        ->pageTextContains('entity_test ' . $id . ' has been created.');
      $this
        ->assertSession()
        ->responseContains($date
        ->format($date_format));
      $this
        ->assertSession()
        ->responseNotContains($date
        ->format($time_format));

      // Verify the date doesn't change if using a timezone that is UTC+12 when
      // the entity is edited through the form.
      $entity = EntityTest::load($id);
      $this
        ->assertEquals('2012-12-31', $entity->{$field_name}->value);
      $this
        ->drupalGet('entity_test/manage/' . $id . '/edit');
      $this
        ->submitForm([], 'Save');
      $this
        ->drupalGet('entity_test/manage/' . $id . '/edit');
      $this
        ->submitForm([], 'Save');
      $this
        ->drupalGet('entity_test/manage/' . $id . '/edit');
      $this
        ->submitForm([], 'Save');
      $entity = EntityTest::load($id);
      $this
        ->assertEquals('2012-12-31', $entity->{$field_name}->value);

      // Reset display options since these get changed below.
      $this->displayOptions = [
        'type' => 'datetime_default',
        'label' => 'hidden',
        'settings' => [
          'format_type' => 'medium',
        ] + $this->defaultSettings,
      ];

      // Verify that the date is output according to the formatter settings.
      $options = [
        'format_type' => [
          'short',
          'medium',
          'long',
        ],
      ];

      // Formats that display a time component for date-only fields will display
      // the default time, so that is applied before calculating the expected
      // value.
      $this
        ->massageTestDate($date);
      foreach ($options as $setting => $values) {
        foreach ($values as $new_value) {

          // Update the entity display settings.
          $this->displayOptions['settings'] = [
            $setting => $new_value,
          ] + $this->defaultSettings;
          $this->container
            ->get('entity_display.repository')
            ->getViewDisplay($this->field
            ->getTargetEntityTypeId(), $this->field
            ->getTargetBundle(), 'full')
            ->setComponent($field_name, $this->displayOptions)
            ->save();
          $this
            ->renderTestEntity($id);
          switch ($setting) {
            case 'format_type':

              // Verify that a date is displayed. Since this is a date-only
              // field, it is expected to display the time as 00:00:00.

              /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
              $date_formatter = $this->container
                ->get('date.formatter');
              $expected = $date_formatter
                ->format($date
                ->getTimestamp(), $new_value, '', DateTimeItemInterface::STORAGE_TIMEZONE);
              $expected_iso = $date_formatter
                ->format($date
                ->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', DateTimeItemInterface::STORAGE_TIMEZONE);
              $output = $this
                ->renderTestEntity($id);
              $expected_markup = '<time datetime="' . $expected_iso . '" class="datetime">' . $expected . '</time>';
              $this
                ->assertStringContainsString($expected_markup, $output, new FormattableMarkup('Formatted date field using %value format displayed as %expected with %expected_iso attribute in %timezone.', [
                '%value' => $new_value,
                '%expected' => $expected,
                '%expected_iso' => $expected_iso,
                '%timezone' => $timezone,
              ]));
              break;
          }
        }
      }

      // Verify that the plain formatter works.
      $this->displayOptions['type'] = 'datetime_plain';
      $this->displayOptions['settings'] = $this->defaultSettings;
      $display_repository
        ->getViewDisplay($this->field
        ->getTargetEntityTypeId(), $this->field
        ->getTargetBundle(), 'full')
        ->setComponent($field_name, $this->displayOptions)
        ->save();
      $expected = $date
        ->format(DateTimeItemInterface::DATE_STORAGE_FORMAT);
      $output = $this
        ->renderTestEntity($id);
      $this
        ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using plain format displayed as %expected in %timezone.', [
        '%expected' => $expected,
        '%timezone' => $timezone,
      ]));

      // Verify that the 'datetime_custom' formatter works.
      $this->displayOptions['type'] = 'datetime_custom';
      $this->displayOptions['settings'] = [
        'date_format' => 'm/d/Y',
      ] + $this->defaultSettings;
      $display_repository
        ->getViewDisplay($this->field
        ->getTargetEntityTypeId(), $this->field
        ->getTargetBundle(), 'full')
        ->setComponent($field_name, $this->displayOptions)
        ->save();
      $expected = $date
        ->format($this->displayOptions['settings']['date_format']);
      $output = $this
        ->renderTestEntity($id);
      $this
        ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using datetime_custom format displayed as %expected in %timezone.', [
        '%expected' => $expected,
        '%timezone' => $timezone,
      ]));

      // Test that allowed markup in custom format is preserved and XSS is
      // removed.
      $this->displayOptions['settings']['date_format'] = '\\<\\s\\t\\r\\o\\n\\g\\>m/d/Y\\<\\/\\s\\t\\r\\o\\n\\g\\>\\<\\s\\c\\r\\i\\p\\t\\>\\a\\l\\e\\r\\t\\(\\S\\t\\r\\i\\n\\g\\.\\f\\r\\o\\m\\C\\h\\a\\r\\C\\o\\d\\e\\(\\8\\8\\,\\8\\3\\,\\8\\3\\)\\)\\<\\/\\s\\c\\r\\i\\p\\t\\>';
      $display_repository
        ->getViewDisplay($this->field
        ->getTargetEntityTypeId(), $this->field
        ->getTargetBundle(), 'full')
        ->setComponent($field_name, $this->displayOptions)
        ->save();
      $expected = '<strong>' . $date
        ->format('m/d/Y') . '</strong>alert(String.fromCharCode(88,83,83))';
      $output = $this
        ->renderTestEntity($id);
      $this
        ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using daterange_custom format displayed as %expected in %timezone.', [
        '%expected' => $expected,
        '%timezone' => $timezone,
      ]));

      // Verify that the 'datetime_time_ago' formatter works for intervals in the
      // past.  First update the test entity so that the date difference always
      // has the same interval.  Since the database always stores UTC, and the
      // interval will use this, force the test date to use UTC and not the local
      // or user timezone.
      $timestamp = REQUEST_TIME - 87654321;
      $entity = EntityTest::load($id);
      $field_name = $this->fieldStorage
        ->getName();
      $date = DrupalDateTime::createFromTimestamp($timestamp, 'UTC');
      $entity->{$field_name}->value = $date
        ->format($date_format);
      $entity
        ->save();
      $this->displayOptions['type'] = 'datetime_time_ago';
      $this->displayOptions['settings'] = [
        'future_format' => '@interval in the future',
        'past_format' => '@interval in the past',
        'granularity' => 3,
      ];
      $display_repository
        ->getViewDisplay($this->field
        ->getTargetEntityTypeId(), $this->field
        ->getTargetBundle(), 'full')
        ->setComponent($field_name, $this->displayOptions)
        ->save();
      $expected = new FormattableMarkup($this->displayOptions['settings']['past_format'], [
        '@interval' => $this->dateFormatter
          ->formatTimeDiffSince($timestamp, [
          'granularity' => $this->displayOptions['settings']['granularity'],
        ]),
      ]);
      $output = $this
        ->renderTestEntity($id);
      $this
        ->assertStringContainsString((string) $expected, $output, new FormattableMarkup('Formatted date field using datetime_time_ago format displayed as %expected in %timezone.', [
        '%expected' => $expected,
        '%timezone' => $timezone,
      ]));

      // Verify that the 'datetime_time_ago' formatter works for intervals in the
      // future.  First update the test entity so that the date difference always
      // has the same interval.  Since the database always stores UTC, and the
      // interval will use this, force the test date to use UTC and not the local
      // or user timezone.
      $timestamp = REQUEST_TIME + 87654321;
      $entity = EntityTest::load($id);
      $field_name = $this->fieldStorage
        ->getName();
      $date = DrupalDateTime::createFromTimestamp($timestamp, 'UTC');
      $entity->{$field_name}->value = $date
        ->format($date_format);
      $entity
        ->save();
      $display_repository
        ->getViewDisplay($this->field
        ->getTargetEntityTypeId(), $this->field
        ->getTargetBundle(), 'full')
        ->setComponent($field_name, $this->displayOptions)
        ->save();
      $expected = new FormattableMarkup($this->displayOptions['settings']['future_format'], [
        '@interval' => $this->dateFormatter
          ->formatTimeDiffUntil($timestamp, [
          'granularity' => $this->displayOptions['settings']['granularity'],
        ]),
      ]);
      $output = $this
        ->renderTestEntity($id);
      $this
        ->assertStringContainsString((string) $expected, $output, new FormattableMarkup('Formatted date field using datetime_time_ago format displayed as %expected in %timezone.', [
        '%expected' => $expected,
        '%timezone' => $timezone,
      ]));
    }
  }

  /**
   * Tests date and time field.
   */
  public function testDatetimeField() {
    $field_name = $this->fieldStorage
      ->getName();
    $field_label = $this->field
      ->label();

    // Change the field to a datetime field.
    $this->fieldStorage
      ->setSetting('datetime_type', 'datetime');
    $this->fieldStorage
      ->save();

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');
    $this
      ->assertSession()
      ->fieldValueEquals("{$field_name}[0][value][date]", '');
    $this
      ->assertSession()
      ->fieldValueEquals("{$field_name}[0][value][time]", '');
    $this
      ->assertSession()
      ->elementTextContains('xpath', '//fieldset[@id="edit-' . $field_name . '-0"]/legend', $field_label);
    $this
      ->assertSession()
      ->elementExists('xpath', '//fieldset[@aria-describedby="edit-' . $field_name . '-0--description"]');
    $this
      ->assertSession()
      ->elementExists('xpath', '//div[@id="edit-' . $field_name . '-0--description"]');

    // Build up a date in the UTC timezone.
    $value = '2012-12-31 00:00:00';
    $date = new DrupalDateTime($value, 'UTC');

    // Update the timezone to the system default.
    $date
      ->setTimezone(timezone_open(date_default_timezone_get()));

    // Submit a valid date and ensure it is accepted.
    $date_format = DateFormat::load('html_date')
      ->getPattern();
    $time_format = DateFormat::load('html_time')
      ->getPattern();
    $edit = [
      "{$field_name}[0][value][date]" => $date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $date
        ->format($time_format),
    ];
    $this
      ->submitForm($edit, 'Save');
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertSession()
      ->pageTextContains('entity_test ' . $id . ' has been created.');
    $this
      ->assertSession()
      ->responseContains($date
      ->format($date_format));
    $this
      ->assertSession()
      ->responseContains($date
      ->format($time_format));

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');

    // Verify that the date is output according to the formatter settings.
    $options = [
      'format_type' => [
        'short',
        'medium',
        'long',
      ],
    ];
    foreach ($options as $setting => $values) {
      foreach ($values as $new_value) {

        // Update the entity display settings.
        $this->displayOptions['settings'] = [
          $setting => $new_value,
        ] + $this->defaultSettings;
        $display_repository
          ->getViewDisplay($this->field
          ->getTargetEntityTypeId(), $this->field
          ->getTargetBundle(), 'full')
          ->setComponent($field_name, $this->displayOptions)
          ->save();
        $this
          ->renderTestEntity($id);
        switch ($setting) {
          case 'format_type':

            // Verify that a date is displayed.
            $date_formatter = $this->container
              ->get('date.formatter');
            $expected = $date_formatter
              ->format($date
              ->getTimestamp(), $new_value);
            $expected_iso = $date_formatter
              ->format($date
              ->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
            $output = $this
              ->renderTestEntity($id);
            $expected_markup = '<time datetime="' . $expected_iso . '" class="datetime">' . $expected . '</time>';
            $this
              ->assertStringContainsString($expected_markup, $output, new FormattableMarkup('Formatted date field using %value format displayed as %expected with %expected_iso attribute.', [
              '%value' => $new_value,
              '%expected' => $expected,
              '%expected_iso' => $expected_iso,
            ]));
            break;
        }
      }
    }

    // Verify that the plain formatter works.
    $this->displayOptions['type'] = 'datetime_plain';
    $this->displayOptions['settings'] = $this->defaultSettings;
    $display_repository
      ->getViewDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'full')
      ->setComponent($field_name, $this->displayOptions)
      ->save();
    $expected = $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    $output = $this
      ->renderTestEntity($id);
    $this
      ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using plain format displayed as %expected.', [
      '%expected' => $expected,
    ]));

    // Verify that the 'datetime_custom' formatter works.
    $this->displayOptions['type'] = 'datetime_custom';
    $this->displayOptions['settings'] = [
      'date_format' => 'm/d/Y g:i:s A',
    ] + $this->defaultSettings;
    $display_repository
      ->getViewDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'full')
      ->setComponent($field_name, $this->displayOptions)
      ->save();
    $expected = $date
      ->format($this->displayOptions['settings']['date_format']);
    $output = $this
      ->renderTestEntity($id);
    $this
      ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using datetime_custom format displayed as %expected.', [
      '%expected' => $expected,
    ]));

    // Verify that the 'timezone_override' setting works.
    $this->displayOptions['type'] = 'datetime_custom';
    $this->displayOptions['settings'] = [
      'date_format' => 'm/d/Y g:i:s A',
      'timezone_override' => 'America/New_York',
    ] + $this->defaultSettings;
    $display_repository
      ->getViewDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'full')
      ->setComponent($field_name, $this->displayOptions)
      ->save();
    $expected = $date
      ->format($this->displayOptions['settings']['date_format'], [
      'timezone' => 'America/New_York',
    ]);
    $output = $this
      ->renderTestEntity($id);
    $this
      ->assertStringContainsString($expected, $output, new FormattableMarkup('Formatted date field using datetime_custom format displayed as %expected.', [
      '%expected' => $expected,
    ]));

    // Verify that the 'datetime_time_ago' formatter works for intervals in the
    // past.  First update the test entity so that the date difference always
    // has the same interval.  Since the database always stores UTC, and the
    // interval will use this, force the test date to use UTC and not the local
    // or user timezone.
    $timestamp = REQUEST_TIME - 87654321;
    $entity = EntityTest::load($id);
    $field_name = $this->fieldStorage
      ->getName();
    $date = DrupalDateTime::createFromTimestamp($timestamp, 'UTC');
    $entity->{$field_name}->value = $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    $entity
      ->save();
    $this->displayOptions['type'] = 'datetime_time_ago';
    $this->displayOptions['settings'] = [
      'future_format' => '@interval from now',
      'past_format' => '@interval earlier',
      'granularity' => 3,
    ];
    $display_repository
      ->getViewDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'full')
      ->setComponent($field_name, $this->displayOptions)
      ->save();
    $expected = new FormattableMarkup($this->displayOptions['settings']['past_format'], [
      '@interval' => $this->dateFormatter
        ->formatTimeDiffSince($timestamp, [
        'granularity' => $this->displayOptions['settings']['granularity'],
      ]),
    ]);
    $output = $this
      ->renderTestEntity($id);
    $this
      ->assertStringContainsString((string) $expected, $output, new FormattableMarkup('Formatted date field using datetime_time_ago format displayed as %expected.', [
      '%expected' => $expected,
    ]));

    // Verify that the 'datetime_time_ago' formatter works for intervals in the
    // future.  First update the test entity so that the date difference always
    // has the same interval.  Since the database always stores UTC, and the
    // interval will use this, force the test date to use UTC and not the local
    // or user timezone.
    $timestamp = REQUEST_TIME + 87654321;
    $entity = EntityTest::load($id);
    $field_name = $this->fieldStorage
      ->getName();
    $date = DrupalDateTime::createFromTimestamp($timestamp, 'UTC');
    $entity->{$field_name}->value = $date
      ->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
    $entity
      ->save();
    $display_repository
      ->getViewDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'full')
      ->setComponent($field_name, $this->displayOptions)
      ->save();
    $expected = new FormattableMarkup($this->displayOptions['settings']['future_format'], [
      '@interval' => $this->dateFormatter
        ->formatTimeDiffUntil($timestamp, [
        'granularity' => $this->displayOptions['settings']['granularity'],
      ]),
    ]);
    $output = $this
      ->renderTestEntity($id);
    $this
      ->assertStringContainsString((string) $expected, $output, new FormattableMarkup('Formatted date field using datetime_time_ago format displayed as %expected.', [
      '%expected' => $expected,
    ]));
  }

  /**
   * Tests Date List Widget functionality.
   */
  public function testDatelistWidget() {
    $field_name = $this->fieldStorage
      ->getName();
    $field_label = $this->field
      ->label();

    // Ensure field is set to a date only field.
    $this->fieldStorage
      ->setSetting('datetime_type', 'date');
    $this->fieldStorage
      ->save();

    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');

    // Change the widget to a datelist widget.
    $display_repository
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle())
      ->setComponent($field_name, [
      'type' => 'datetime_datelist',
      'settings' => [
        'date_order' => 'YMD',
      ],
    ])
      ->save();
    \Drupal::service('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');
    $this
      ->assertSession()
      ->elementTextContains('xpath', '//fieldset[@id="edit-' . $field_name . '-0"]/legend', $field_label);
    $this
      ->assertSession()
      ->elementExists('xpath', '//fieldset[@aria-describedby="edit-' . $field_name . '-0--description"]');
    $this
      ->assertSession()
      ->elementExists('xpath', '//div[@id="edit-' . $field_name . '-0--description"]');

    // Assert that Hour and Minute Elements do not appear on Date Only
    $this
      ->assertSession()
      ->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-hour\"]");
    $this
      ->assertSession()
      ->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-minute\"]");

    // Go to the form display page to assert that increment option does not appear on Date Only
    $fieldEditUrl = 'entity_test/structure/entity_test/form-display';
    $this
      ->drupalGet($fieldEditUrl);

    // Click on the widget settings button to open the widget settings form.
    $this
      ->submitForm([], $field_name . "_settings_edit");
    $xpathIncr = "//select[starts-with(@id, \"edit-fields-{$field_name}-settings-edit-form-settings-increment\")]";
    $this
      ->assertSession()
      ->elementNotExists('xpath', $xpathIncr);

    // Change the field to a datetime field.
    $this->fieldStorage
      ->setSetting('datetime_type', 'datetime');
    $this->fieldStorage
      ->save();

    // Change the widget to a datelist widget.
    $display_repository
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle())
      ->setComponent($field_name, [
      'type' => 'datetime_datelist',
      'settings' => [
        'increment' => 1,
        'date_order' => 'YMD',
        'time_type' => '12',
      ],
    ])
      ->save();
    \Drupal::service('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Go to the form display page to assert that increment option does appear on Date Time
    $fieldEditUrl = 'entity_test/structure/entity_test/form-display';
    $this
      ->drupalGet($fieldEditUrl);

    // Click on the widget settings button to open the widget settings form.
    $this
      ->submitForm([], $field_name . "_settings_edit");
    $this
      ->assertSession()
      ->elementExists('xpath', $xpathIncr);

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');

    // Year element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-year\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-year", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-year", 'Year');

    // Month element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-month\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-month", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-month", 'Month');

    // Day element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-day\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-day", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-day", 'Day');

    // Hour element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-hour\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-hour", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-hour", 'Hour');

    // Minute element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-minute\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-minute", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-minute", 'Minute');

    // No Second element.
    $this
      ->assertSession()
      ->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-second\"]");

    // AMPM element.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-ampm\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-ampm", '')
      ->isSelected());
    $this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-ampm", 'AM/PM');

    // Submit a valid date and ensure it is accepted.
    $date_value = [
      'year' => 2012,
      'month' => 12,
      'day' => 31,
      'hour' => 5,
      'minute' => 15,
    ];
    $edit = [];

    // Add the ampm indicator since we are testing 12 hour time.
    $date_value['ampm'] = 'am';
    foreach ($date_value as $part => $value) {
      $edit["{$field_name}[0][value][{$part}]"] = $value;
    }
    $this
      ->submitForm($edit, 'Save');
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertSession()
      ->pageTextContains('entity_test ' . $id . ' has been created.');
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-year", '2012')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-month", '12')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-day", '31')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-hour", '5')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-minute", '15')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-ampm", 'am')
      ->isSelected());

    // Test the widget using increment other than 1 and 24 hour mode.
    $display_repository
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle())
      ->setComponent($field_name, [
      'type' => 'datetime_datelist',
      'settings' => [
        'increment' => 15,
        'date_order' => 'YMD',
        'time_type' => '24',
      ],
    ])
      ->save();
    \Drupal::service('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');

    // Other elements are unaffected by the changed settings.
    $this
      ->assertSession()
      ->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-hour\"]");
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-hour", '')
      ->isSelected());
    $this
      ->assertSession()
      ->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-value-ampm\"]");

    // Submit a valid date and ensure it is accepted.
    $date_value = [
      'year' => 2012,
      'month' => 12,
      'day' => 31,
      'hour' => 17,
      'minute' => 15,
    ];
    $edit = [];
    foreach ($date_value as $part => $value) {
      $edit["{$field_name}[0][value][{$part}]"] = $value;
    }
    $this
      ->submitForm($edit, 'Save');
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertSession()
      ->pageTextContains('entity_test ' . $id . ' has been created.');
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-year", '2012')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-month", '12')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-day", '31')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-hour", '17')
      ->isSelected());
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-minute", '15')
      ->isSelected());

    // Test the widget for partial completion of fields.
    $display_repository
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle())
      ->setComponent($field_name, [
      'type' => 'datetime_datelist',
      'settings' => [
        'increment' => 1,
        'date_order' => 'YMD',
        'time_type' => '24',
      ],
    ])
      ->save();
    \Drupal::service('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Test the widget for validation notifications.
    foreach ($this
      ->datelistDataProvider($field_label) as $data) {
      list($date_value, $expected) = $data;

      // Display creation form.
      $this
        ->drupalGet('entity_test/add');

      // Submit a partial date and ensure and error message is provided.
      $edit = [];
      foreach ($date_value as $part => $value) {
        $edit["{$field_name}[0][value][{$part}]"] = $value;
      }
      $this
        ->submitForm($edit, 'Save');
      $this
        ->assertSession()
        ->statusCodeEquals(200);
      foreach ($expected as $expected_text) {
        $this
          ->assertSession()
          ->pageTextContains($expected_text);
      }
    }

    // Test the widget for complete input with zeros as part of selections.
    $this
      ->drupalGet('entity_test/add');
    $date_value = [
      'year' => 2012,
      'month' => '12',
      'day' => '31',
      'hour' => '0',
      'minute' => '0',
    ];
    $edit = [];
    foreach ($date_value as $part => $value) {
      $edit["{$field_name}[0][value][{$part}]"] = $value;
    }
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertSession()
      ->pageTextContains('entity_test ' . $id . ' has been created.');

    // Test the widget to ensure zeros are not deselected on validation.
    $this
      ->drupalGet('entity_test/add');
    $date_value = [
      'year' => 2012,
      'month' => '12',
      'day' => '31',
      'hour' => '',
      'minute' => '0',
    ];
    $edit = [];
    foreach ($date_value as $part => $value) {
      $edit["{$field_name}[0][value][{$part}]"] = $value;
    }
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists("edit-{$field_name}-0-value-minute", '0')
      ->isSelected());
  }

  /**
   * The data provider for testing the validation of the datelist widget.
   *
   * @param string $field_label
   *   The label of the field being tested.
   *
   * @return array
   *   An array of datelist input permutations to test.
   */
  protected function datelistDataProvider($field_label) {
    return [
      // Nothing selected.
      [
        [
          'year' => '',
          'month' => '',
          'day' => '',
          'hour' => '',
          'minute' => '',
        ],
        [
          "The {$field_label} date is required.",
        ],
      ],
      // Year only selected, validation error on Month, Day, Hour, Minute.
      [
        [
          'year' => 2012,
          'month' => '',
          'day' => '',
          'hour' => '',
          'minute' => '',
        ],
        [
          "The {$field_label} date is incomplete.",
          'A value must be selected for month.',
          'A value must be selected for day.',
          'A value must be selected for hour.',
          'A value must be selected for minute.',
        ],
      ],
      // Year and Month selected, validation error on Day, Hour, Minute.
      [
        [
          'year' => 2012,
          'month' => '12',
          'day' => '',
          'hour' => '',
          'minute' => '',
        ],
        [
          "The {$field_label} date is incomplete.",
          'A value must be selected for day.',
          'A value must be selected for hour.',
          'A value must be selected for minute.',
        ],
      ],
      // Year, Month and Day selected, validation error on Hour, Minute.
      [
        [
          'year' => 2012,
          'month' => '12',
          'day' => '31',
          'hour' => '',
          'minute' => '',
        ],
        [
          "The {$field_label} date is incomplete.",
          'A value must be selected for hour.',
          'A value must be selected for minute.',
        ],
      ],
      // Year, Month, Day and Hour selected, validation error on Minute only.
      [
        [
          'year' => 2012,
          'month' => '12',
          'day' => '31',
          'hour' => '0',
          'minute' => '',
        ],
        [
          "The {$field_label} date is incomplete.",
          'A value must be selected for minute.',
        ],
      ],
    ];
  }

  /**
   * Tests default value functionality.
   */
  public function testDefaultValue() {

    // Create a test content type.
    $this
      ->drupalCreateContentType([
      'type' => 'date_content',
    ]);

    // Create a field storage with settings to validate.
    $field_name = mb_strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => 'node',
      'type' => 'datetime',
      'settings' => [
        'datetime_type' => 'date',
      ],
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'date_content',
    ]);
    $field
      ->save();

    // Loop through defined timezones to test that date-only defaults work at
    // the extremes.
    foreach (static::$timezones as $timezone) {
      $this
        ->setSiteTimezone($timezone);
      $this
        ->assertEquals($timezone, $this
        ->config('system.date')
        ->get('timezone.default'), 'Time zone set to ' . $timezone);

      // Set now as default_value.
      $field_edit = [
        'default_value_input[default_date_type]' => 'now',
      ];
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->submitForm($field_edit, 'Save settings');

      // Check that default value is selected in default value form.
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->assertTrue($this
        ->assertSession()
        ->optionExists('edit-default-value-input-default-date-type', 'now')
        ->isSelected());

      // Check that the relative default value is empty.
      $this
        ->assertSession()
        ->fieldValueEquals('default_value_input[default_date]', '');

      // Check if default_date has been stored successfully.
      $config_entity = $this
        ->config('field.field.node.date_content.' . $field_name)
        ->get();
      $this
        ->assertEquals([
        'default_date_type' => 'now',
        'default_date' => 'now',
      ], $config_entity['default_value'][0], 'Default value has been stored successfully');

      // Clear field cache in order to avoid stale cache values.
      \Drupal::service('entity_field.manager')
        ->clearCachedFieldDefinitions();

      // Create a new node to check that datetime field default value is today.
      $new_node = Node::create([
        'type' => 'date_content',
      ]);
      $expected_date = new DrupalDateTime('now', date_default_timezone_get());
      $this
        ->assertEquals($expected_date
        ->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node
        ->get($field_name)
        ->offsetGet(0)->value);

      // Set an invalid relative default_value to test validation.
      $field_edit = [
        'default_value_input[default_date_type]' => 'relative',
        'default_value_input[default_date]' => 'invalid date',
      ];
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->submitForm($field_edit, 'Save settings');
      $this
        ->assertSession()
        ->pageTextContains('The relative date value entered is invalid.');

      // Set a relative default_value.
      $field_edit = [
        'default_value_input[default_date_type]' => 'relative',
        'default_value_input[default_date]' => '+90 days',
      ];
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->submitForm($field_edit, 'Save settings');

      // Check that default value is selected in default value form.
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->assertTrue($this
        ->assertSession()
        ->optionExists('edit-default-value-input-default-date-type', 'relative')
        ->isSelected());

      // Check that the relative default value is displayed.
      $this
        ->assertSession()
        ->fieldValueEquals('default_value_input[default_date]', '+90 days');

      // Check if default_date has been stored successfully.
      $config_entity = $this
        ->config('field.field.node.date_content.' . $field_name)
        ->get();
      $this
        ->assertEquals([
        'default_date_type' => 'relative',
        'default_date' => '+90 days',
      ], $config_entity['default_value'][0], 'Default value has been stored successfully');

      // Clear field cache in order to avoid stale cache values.
      \Drupal::service('entity_field.manager')
        ->clearCachedFieldDefinitions();

      // Create a new node to check that datetime field default value is +90
      // days.
      $new_node = Node::create([
        'type' => 'date_content',
      ]);
      $expected_date = new DrupalDateTime('+90 days', date_default_timezone_get());
      $this
        ->assertEquals($expected_date
        ->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node
        ->get($field_name)
        ->offsetGet(0)->value);

      // Remove default value.
      $field_edit = [
        'default_value_input[default_date_type]' => '',
      ];
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->submitForm($field_edit, 'Save settings');

      // Check that default value is selected in default value form.
      $this
        ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
      $this
        ->assertTrue($this
        ->assertSession()
        ->optionExists('edit-default-value-input-default-date-type', '')
        ->isSelected());

      // Check that the relative default value is empty.
      $this
        ->assertSession()
        ->fieldValueEquals('default_value_input[default_date]', '');

      // Check if default_date has been stored successfully.
      $config_entity = $this
        ->config('field.field.node.date_content.' . $field_name)
        ->get();
      $this
        ->assertTrue(empty($config_entity['default_value']), 'Empty default value has been stored successfully');

      // Clear field cache in order to avoid stale cache values.
      \Drupal::service('entity_field.manager')
        ->clearCachedFieldDefinitions();

      // Create a new node to check that datetime field default value is not
      // set.
      $new_node = Node::create([
        'type' => 'date_content',
      ]);
      $this
        ->assertNull($new_node
        ->get($field_name)->value, 'Default value is not set');
    }
  }

  /**
   * Tests that invalid values are caught and marked as invalid.
   */
  public function testInvalidField() {

    // Change the field to a datetime field.
    $this->fieldStorage
      ->setSetting('datetime_type', 'datetime');
    $this->fieldStorage
      ->save();
    $field_name = $this->fieldStorage
      ->getName();

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');
    $this
      ->assertSession()
      ->fieldValueEquals("{$field_name}[0][value][date]", '');
    $this
      ->assertSession()
      ->fieldValueEquals("{$field_name}[0][value][time]", '');

    // Submit invalid dates and ensure they is not accepted.
    $date_value = '';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => '12:00:00',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid year value.
    $date_value = 'aaaa-12-01';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => '00:00:00',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid month value.
    $date_value = '2012-75-01';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => '00:00:00',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid day value.
    $date_value = '2012-12-99';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => '00:00:00',
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid time value.
    $date_value = '2012-12-01';
    $time_value = '';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => $time_value,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid hour value.
    $date_value = '2012-12-01';
    $time_value = '49:00:00';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => $time_value,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid minutes value.
    $date_value = '2012-12-01';
    $time_value = '12:99:00';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => $time_value,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');

    // Invalid seconds value.
    $date_value = '2012-12-01';
    $time_value = '12:15:99';
    $edit = [
      "{$field_name}[0][value][date]" => $date_value,
      "{$field_name}[0][value][time]" => $time_value,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->assertSession()
      ->pageTextContains('date is invalid');
  }

  /**
   * Tests that 'Date' field storage setting form is disabled if field has data.
   */
  public function testDateStorageSettings() {

    // Create a test content type.
    $this
      ->drupalCreateContentType([
      'type' => 'date_content',
    ]);

    // Create a field storage with settings to validate.
    $field_name = mb_strtolower($this
      ->randomMachineName());
    $field_storage = FieldStorageConfig::create([
      'field_name' => $field_name,
      'entity_type' => 'node',
      'type' => 'datetime',
      'settings' => [
        'datetime_type' => 'date',
      ],
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'field_name' => $field_name,
      'bundle' => 'date_content',
    ]);
    $field
      ->save();
    \Drupal::service('entity_display.repository')
      ->getFormDisplay('node', 'date_content')
      ->setComponent($field_name, [
      'type' => 'datetime_default',
    ])
      ->save();
    $edit = [
      'title[0][value]' => $this
        ->randomString(),
      'body[0][value]' => $this
        ->randomString(),
      $field_name . '[0][value][date]' => '2016-04-01',
    ];
    $this
      ->drupalGet('node/add/date_content');
    $this
      ->submitForm($edit, 'Save');
    $this
      ->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name . '/storage');
    $result = $this
      ->xpath("//*[@id='edit-settings-datetime-type' and contains(@disabled, 'disabled')]");
    $this
      ->assertCount(1, $result, "Changing datetime setting is disabled.");
    $this
      ->assertSession()
      ->pageTextContains('There is data for this field in the database. The field settings can no longer be changed.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	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::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
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	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	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::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
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::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::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
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
DateTestBase::$dateFormatter	protected	property	The date formatter service.
DateTestBase::$displayOptions	protected	property	An array of display options.
DateTestBase::$field	protected	property	The field used in this test class.
DateTestBase::$fieldStorage	protected	property	A field storage to use in this test class.
DateTestBase::$modules	protected static	property	Modules to enable. Overrides BrowserTestBase::$modules	1
DateTestBase::$timezones	protected static	property	An array of timezone extremes to test.
DateTestBase::createField	protected	function	Creates a date test field.
DateTestBase::massageTestDate	protected	function	Massages test date values.
DateTestBase::renderTestEntity	protected	function	Renders an entity_test and sets the output in the internal browser.
DateTestBase::setSiteTimezone	protected	function	Sets the site timezone to a given timezone.
DateTestBase::setUp	protected	function	Overrides BrowserTestBase::setUp
DateTimeFieldTest::$defaultSettings	protected	property	The default display settings to use for the formatters.
DateTimeFieldTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DateTimeFieldTest::datelistDataProvider	protected	function	The data provider for testing the validation of the datelist widget.
DateTimeFieldTest::getTestFieldType	protected	function	Returns the type of field to be tested. Overrides DateTestBase::getTestFieldType
DateTimeFieldTest::testDateField	public	function	Tests date field functionality.
DateTimeFieldTest::testDatelistWidget	public	function	Tests Date List Widget functionality.
DateTimeFieldTest::testDateStorageSettings	public	function	Tests that 'Date' field storage setting form is disabled if field has data.
DateTimeFieldTest::testDatetimeField	public	function	Tests date and time field.
DateTimeFieldTest::testDefaultValue	public	function	Tests default value functionality.
DateTimeFieldTest::testInvalidField	public	function	Tests that invalid values are caught and marked as invalid.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
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::$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.	1
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.	20
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.	1
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
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.	1
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.
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.	1
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.	1
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 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::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
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 Deprecated	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::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
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.