You are here

Home » API reference » Datetime Extras 8 » DateRangeDurationWidgetTest.php

class DateRangeDurationWidgetTest in Datetime Extras 8

Test the DateRangeDurationWidget for datetime_range fields.

@group datetime_extras

Hierarchy

Expanded class hierarchy of DateRangeDurationWidgetTest

File

tests/src/Functional/DateRangeDurationWidgetTest.php, line 15

Namespace

Drupal\Tests\datetime_extras\Functional
View source 
class DateRangeDurationWidgetTest extends DateTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'datetime_range',
    'datetime_extras',
    'duration_field',
  ];

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

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

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

  /**
   * Gets an entity form display via the correct method based on core version.
   *
   * The entity_get_form_display() procedural function is the only way prior to
   * drupal:8.8.0, but that method is deprecated in 8.8.0 and above.
   *
   * @todo In https://www.drupal.org/node/3129008 remove this technical debt
   *   once we drop support for Drupal core version 8.7.x.
   *
   * @param string $entity_type_id
   *   The entity type ID.
   * @param string $bundle_id
   *   The entity bundle ID.
   * @param string $form_mode
   *   Which form mode to load.
   *
   * @return \Drupal\Core\Entity\Display\EntityFormDisplayInterface
   *   The entity form display associated with the given form mode.
   */
  protected function getFormDisplay($entity_type_id, $bundle_id, $form_mode) {
    if (floatval(\Drupal::VERSION) >= 8.800000000000001) {
      return \Drupal::service('entity_display.repository')
        ->getFormDisplay($entity_type_id, $bundle_id, $form_mode);
    }

    // This is fallback code for 8.7.x and below. It's not called on later
    // versions, so we don't nee to "fix" it for upgrade_status.
    // The @noRector *needs* to be in /** */ to work, but our code sniffer
    // configuration flags that as an error, so we ignore the next line. ;)
    // @codingStandardsIgnoreLine

    /** @noRector \DrupalRector\Rector\Deprecation\EntityGetFormDisplayRector */

    // @phpstan-ignore-next-line
    return entity_get_form_display($entity_type_id, $bundle_id, $form_mode);
  }

  /**
   * Tests Date Range List Widget functionality.
   */
  public function testDateRangeDurationWidget() {
    $field_name = $this->fieldStorage
      ->getName();
    $field_label = $this->field
      ->label();
    $session = $this
      ->getSession();
    $page = $session
      ->getPage();

    // Ensure field is set to a datetime field.
    $this->fieldStorage
      ->setSetting('datetime_type', DateRangeItem::DATETIME_TYPE_DATETIME);
    $this->fieldStorage
      ->save();

    // Change the widget to a daterange_duration with some default settings.
    $this
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'default')
      ->setComponent($field_name, [
      'type' => 'daterange_duration',
      'settings' => [
        'duration_granularity' => 'd:h:i',
        'time_increment' => '300',
        'default_duration' => [
          'h' => '2',
          'i' => '15',
        ],
      ],
    ])
      ->save();
    $this->container
      ->get('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Display creation form.
    $this
      ->drupalGet('entity_test/add');
    $this
      ->assertFieldByName("{$field_name}[0][value][date]", '', 'Start date element found.');
    $this
      ->assertFieldByName("{$field_name}[0][value][time]", '', 'Start time element found.');
    $end_type_id = "edit-{$field_name}-0-end-type";
    $duration_radio = $this
      ->xpath('//div[@id=:id]//input[@value=:value]', [
      ':id' => $end_type_id,
      ':value' => 'duration',
    ]);
    $this
      ->assertCount(1, $duration_radio, 'A radio button has a "Duration" choice.');
    $end_date_radio = $this
      ->xpath('//div[@id=:id]//input[@value=:value]', [
      ':id' => $end_type_id,
      ':value' => 'end_date',
    ]);
    $this
      ->assertCount(1, $end_date_radio, 'A radio button has an "End date" choice.');

    // No JS, these should still be visible.
    $this
      ->assertFieldByName("{$field_name}[0][end_value][date]", '', 'End date element found.');
    $this
      ->assertFieldByName("{$field_name}[0][end_value][time]", '', 'End time element found.');

    // Check the duration field elements.
    // Make sure granularity setting works so that  y, m and s are gone:
    $this
      ->assertNoFieldByXpath("//input[@id = 'edit-{$field_name}-0-duration-y']", NULL, 'Duration years is not shown.');
    $this
      ->assertNoFieldByXpath("//input[@id = 'edit-{$field_name}-0-duration-m']", NULL, 'Duration months is not shown.');
    $this
      ->assertNoFieldByXpath("//input[@id = 'edit-{$field_name}-0-duration-s']", NULL, 'Duration seconds is not shown.');

    // Make sure the default duration setting works on the remaining elements:
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '0', 'Default duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '2', 'Default duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '15', 'Default duration minutes is set correctly.');

    // Build up dates in the UTC timezone.
    $value = '1917-11-07 00:00:00';
    $start_date = new DrupalDateTime($value, 'UTC');
    $date_format = DateFormat::load('html_date')
      ->getPattern();
    $time_format = DateFormat::load('html_time')
      ->getPattern();

    // First, submit a start date, using the default duration (and no end
    // date) and ensure the end_value is set correctly:
    $edit = [
      "{$field_name}[0][value][date]" => $start_date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $start_date
        ->format($time_format),
      "{$field_name}[0][end_type]" => 'duration',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertText(t('entity_test @id has been created.', [
      '@id' => $id,
    ]));
    $this
      ->assertRaw($start_date
      ->format($date_format));
    $this
      ->assertRaw($start_date
      ->format($time_format));

    // The end date is hidden by default, so we can't just assertRaw() for the
    // date or time. Instead, assert the field values in the widget.
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '0', 'Duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '2', 'Duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '15', 'Duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1917-11-07', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '02:15:00', 'End time is set correctly.');

    // Now, submit a start date, change the duration, still no end date:
    $start_date = new DrupalDateTime('1917-11-07 03:05:00', 'UTC');
    $edit = [
      "{$field_name}[0][value][date]" => $start_date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $start_date
        ->format($time_format),
      "{$field_name}[0][end_type]" => 'duration',
      // 10 days that shook the world.
      "{$field_name}[0][duration][d]" => 10,
      // And a little more, to keep things interesting.
      "{$field_name}[0][duration][h]" => 1,
      "{$field_name}[0][duration][i]" => 30,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));

    // Make sure the new start time is happening.
    $this
      ->assertRaw($start_date
      ->format($date_format));
    $this
      ->assertRaw($start_date
      ->format($time_format));

    // Check that the duration and end_value is correct:
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '10', 'Duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '1', 'Duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '30', 'Duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1917-11-17', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '04:35:00', 'End time is set correctly.');

    // Now, set a new end time directly, leaving the duration values in the
    // form, and see that when the page reloads, we have the right end time and
    // the correct new duration values pre-filled.
    $edit = [
      "{$field_name}[0][value][date]" => $start_date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $start_date
        ->format($time_format),
      "{$field_name}[0][end_type]" => 'end_date',
      "{$field_name}[0][end_value][date]" => '1917-11-11',
      "{$field_name}[0][end_value][time]" => '08:45:00',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertRaw($start_date
      ->format($date_format));
    $this
      ->assertRaw($start_date
      ->format($time_format));

    // start_date is '1917-11-07 03:05:00'.
    // end_value is  '1917-11-11 08:45:00'.
    // Duration should be 4 days, 5 hours, 40 minutes.
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '4', 'Duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '5', 'Duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '40', 'Duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1917-11-11', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '08:45:00', 'End time is set correctly.');

    // Now, change the widget settings to use the full duration granularity.
    // Change the widget to a daterange_duration with some default settings.
    $this
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'default')
      ->setComponent($field_name, [
      'type' => 'daterange_duration',
      'settings' => [
        'duration_granularity' => 'y:m:d:h:i:s',
        'time_increment' => '1',
        'default_duration' => [
          'd' => '2',
          'h' => '4',
          'i' => '20',
          's' => '5',
        ],
      ],
    ])
      ->save();
    $this->container
      ->get('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Start over with a new entity.
    $this
      ->drupalGet('entity_test/add');

    // Make sure granularity works and we see all the duration elements:
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-y']"), '0', 'Default duration years is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-m']"), '0', 'Default duration months is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '2', 'Default duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '4', 'Default duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '20', 'Default duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-s']"), '5', 'Default duration seconds is set correctly.');

    // Ensure the default duration works with all these elements.
    $edit = [
      "{$field_name}[0][value][date]" => $start_date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $start_date
        ->format($time_format),
      "{$field_name}[0][end_type]" => 'duration',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertText(t('entity_test @id has been created.', [
      '@id' => $id,
    ]));
    $this
      ->assertRaw($start_date
      ->format($date_format));
    $this
      ->assertRaw($start_date
      ->format($time_format));

    // None of this should have changed.
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-y']"), '0', 'Duration years is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-m']"), '0', 'Duration months is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '2', 'Duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '4', 'Duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '20', 'Duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-s']"), '5', 'Duration seconds is set correctly.');

    // start_date is '1917-11-07 03:05:00'.
    // end_value should be '1917-11-09 07:25:05'.
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1917-11-09', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '07:25:05', 'End time is set correctly.');

    // Try to use all the duration elements with unique values.
    $edit = [
      "{$field_name}[0][value][date]" => $start_date
        ->format($date_format),
      "{$field_name}[0][value][time]" => $start_date
        ->format($time_format),
      "{$field_name}[0][end_type]" => 'duration',
      "{$field_name}[0][duration][y]" => 2,
      "{$field_name}[0][duration][m]" => 1,
      "{$field_name}[0][duration][d]" => 4,
      "{$field_name}[0][duration][h]" => 5,
      "{$field_name}[0][duration][i]" => 10,
      "{$field_name}[0][duration][s]" => 45,
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertRaw($start_date
      ->format($date_format));
    $this
      ->assertRaw($start_date
      ->format($time_format));
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-y']"), '2', 'Duration years is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-m']"), '1', 'Default duration months is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '4', 'Default duration days is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '5', 'Default duration hours is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '10', 'Default duration minutes is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-s']"), '45', 'Default duration seconds is set correctly.');

    // start_date is '1917-11-07 03:05:00'.
    // end_value should be '1919-12-11 08:15:45'.
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1919-12-11', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '08:15:45', 'End time is set correctly.');

    // Test the widget for validation notifications.
    // Change the widget settings to use the full duration granularity, but
    // no default duration.
    $this
      ->getFormDisplay($this->field
      ->getTargetEntityTypeId(), $this->field
      ->getTargetBundle(), 'default')
      ->setComponent($field_name, [
      'type' => 'daterange_duration',
      'settings' => [
        'duration_granularity' => 'y:m:d:h:i:s',
        'time_increment' => '1',
        'default_duration' => [],
      ],
    ])
      ->save();
    $this->container
      ->get('entity_field.manager')
      ->clearCachedFieldDefinitions();

    // Define a start time, pick duration, set it to empty, end time should be
    // the same as start time.
    $this
      ->drupalGet('entity_test/add');
    $edit = [
      "{$field_name}[0][value][date]" => '1917-11-07',
      "{$field_name}[0][value][time]" => '03:00:00',
      "{$field_name}[0][end_type]" => 'duration',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertResponse(200);
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertText(t('entity_test @id has been created.', [
      '@id' => $id,
    ]));
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-date']"), '1917-11-07', 'End date is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-end-value-time']"), '03:00:00', 'End time is set correctly.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-y']"), '0', 'Duration years is empty.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-m']"), '0', 'Default duration months is empty.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-d']"), '0', 'Default duration days is empty.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-h']"), '0', 'Default duration hours is empty.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-i']"), '0', 'Default duration minutes is empty.');
    $this
      ->assertFieldsByValue($this
      ->xpath("//input[@id = 'edit-{$field_name}-0-duration-s']"), '0', 'Default duration seconds is empty.');

    // Define a start time, use end_date radio, but leave it empty.
    $this
      ->drupalGet('entity_test/add');
    $edit = [
      "{$field_name}[0][value][date]" => '1917-11-07',
      "{$field_name}[0][value][time]" => '03:00:00',
      "{$field_name}[0][end_type]" => 'end_date',
    ];
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertResponse(200);
    $this
      ->assertText(t('You must define either a duration or an end date.'));

    // Now, set the field to not be required and try again.
    $this->field
      ->setRequired(FALSE)
      ->save();

    // We should hit core's validation error about a partial daterange value.
    $this
      ->drupalGet('entity_test/add');

    // Intentionally re-using the same $edit array from above.
    $this
      ->drupalPostForm(NULL, $edit, t('Save'));
    $this
      ->assertResponse(200);
    $this
      ->assertText(t('This value should not be null.'));

    // Completely empty values, field isn't required, should be no problem.
    $this
      ->drupalGet('entity_test/add');
    $this
      ->drupalPostForm(NULL, [], t('Save'));
    $this
      ->assertResponse(200);
    preg_match('|entity_test/manage/(\\d+)|', $this
      ->getUrl(), $match);
    $id = $match[1];
    $this
      ->assertText(t('entity_test @id has been created.', [
      '@id' => $id,
    ]));
  }

}

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
DateRangeDurationWidgetTest::$defaultSettings protected property The default display settings to use for the formatters.
DateRangeDurationWidgetTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DateRangeDurationWidgetTest::$modules public static property Modules to enable. Overrides DateTestBase::$modules
DateRangeDurationWidgetTest::getFormDisplay protected function Gets an entity form display via the correct method based on core version.
DateRangeDurationWidgetTest::getTestFieldType protected function Returns the type of field to be tested. Overrides DateTestBase::getTestFieldType
DateRangeDurationWidgetTest::testDateRangeDurationWidget public function Tests Date Range List Widget functionality.
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::$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 a 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
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.
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.