class DateRangeFieldTest
Same name in this branch
- 10 core/modules/datetime_range/tests/src/FunctionalJavascript/DateRangeFieldTest.php \Drupal\Tests\datetime_range\FunctionalJavascript\DateRangeFieldTest
Same name in other branches
- 9 core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php \Drupal\Tests\datetime_range\Functional\DateRangeFieldTest
- 8.9.x core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php \Drupal\Tests\datetime_range\Functional\DateRangeFieldTest
- 11.x core/modules/datetime_range/tests/src/Functional/DateRangeFieldTest.php \Drupal\Tests\datetime_range\Functional\DateRangeFieldTest
- 11.x core/modules/datetime_range/tests/src/FunctionalJavascript/DateRangeFieldTest.php \Drupal\Tests\datetime_range\FunctionalJavascript\DateRangeFieldTest
Tests Daterange field functionality.
@group datetime @group #slow
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\Tests\datetime\Functional\DateTestBase extends \Drupal\Tests\BrowserTestBase
- class \Drupal\Tests\datetime_range\Functional\DateRangeFieldTest extends \Drupal\Tests\datetime\Functional\DateTestBase
- class \Drupal\Tests\datetime\Functional\DateTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of DateRangeFieldTest
File
-
core/
modules/ datetime_range/ tests/ src/ Functional/ DateRangeFieldTest.php, line 24
Namespace
Drupal\Tests\datetime_range\FunctionalView source
class DateRangeFieldTest extends DateTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'datetime_range',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* The default display settings to use for the formatters.
*
* @var array
*/
protected $defaultSettings = [
'timezone_override' => '',
'separator' => '-',
'from_to' => DateTimeRangeConstantsInterface::BOTH,
];
/**
* {@inheritdoc}
*/
protected function getTestFieldType() {
return 'daterange';
}
/**
* Tests date field functionality.
*/
public function testDateRangeField() : void {
$field_name = $this->fieldStorage
->getName();
$field_label = $this->field
->label();
// 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);
// Ensure field is set to a date-only field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::DATETIME_TYPE_DATE);
$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][end_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]");
$this->assertSession()
->fieldNotExists("{$field_name}[0][end_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 dates in the UTC timezone.
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, 'UTC');
$end_value = '2013-06-06 00:00:00';
$end_date = new DrupalDateTime($end_value, 'UTC');
// 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]" => $start_date->format($date_format),
"{$field_name}[0][end_value][date]" => $end_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($start_date->format($date_format));
$this->assertSession()
->responseNotContains($start_date->format($time_format));
$this->assertSession()
->responseContains($end_date->format($date_format));
$this->assertSession()
->responseNotContains($end_date->format($time_format));
// Verify the date doesn't change when entity is edited through the form.
$entity = EntityTest::load($id);
$this->assertEquals('2012-12-31', $entity->{$field_name}->value);
$this->assertEquals('2013-06-06', $entity->{$field_name}->end_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);
$this->assertEquals('2013-06-06', $entity->{$field_name}->end_value);
// 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($start_date);
$this->massageTestDate($end_date);
// Reset display options since these get changed below.
$this->displayOptions = [
'type' => 'daterange_default',
'label' => 'hidden',
'settings' => [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings,
];
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Verify that the default formatter works.
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long', '', DateTimeItemInterface::STORAGE_TIMEZONE);
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', DateTimeItemInterface::STORAGE_TIMEZONE);
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$end_expected = $this->dateFormatter
->format($end_date->getTimestamp(), 'long', '', DateTimeItemInterface::STORAGE_TIMEZONE);
$end_expected_iso = $this->dateFormatter
->format($end_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', DateTimeItemInterface::STORAGE_TIMEZONE);
$end_expected_markup = '<time datetime="' . $end_expected_iso . '">' . $end_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute in {$timezone}.");
$this->assertStringContainsString($end_expected_markup, $output, "Formatted date field using long format displayed as {$end_expected} with {$end_expected_iso} attribute in {$timezone}.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//div[@data-field-item-attr="foobar"]');
// Verify that the plain formatter works.
$this->displayOptions['type'] = 'daterange_plain';
$this->displayOptions['settings'] = $this->defaultSettings;
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT) . ' - ' . $end_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected} in {$timezone}.");
// Verify that the custom formatter works.
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format']) . ' - ' . $end_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected} in {$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>' . $start_date->format('m/d/Y') . '</strong>alert(String.fromCharCode(88,83,83)) - <strong>' . $end_date->format('m/d/Y') . '</strong>alert(String.fromCharCode(88,83,83))';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected} in {$timezone}.");
// Test formatters when start date and end date are the same.
$this->drupalGet('entity_test/add');
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, 'UTC');
$date_format = DateFormat::load('html_date')->getPattern();
$time_format = DateFormat::load('html_time')->getPattern();
$edit = [
"{$field_name}[0][value][date]" => $start_date->format($date_format),
"{$field_name}[0][end_value][date]" => $start_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->massageTestDate($start_date);
$this->displayOptions = [
'type' => 'daterange_default',
'label' => 'hidden',
'settings' => [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings,
];
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long', '', DateTimeItemInterface::STORAGE_TIMEZONE);
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', DateTimeItemInterface::STORAGE_TIMEZONE);
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute in {$timezone}.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page in ' . $timezone);
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//time[@data-field-item-attr="foobar"]');
$this->displayOptions['type'] = 'daterange_plain';
$this->displayOptions['settings'] = $this->defaultSettings;
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected} in {$timezone}.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page');
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected} in {$timezone}.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page');
}
}
/**
* Tests date and time field.
*/
public function testDatetimeRangeField() : void {
$field_name = $this->fieldStorage
->getName();
$field_label = $this->field
->label();
// Ensure the field to a datetime field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::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()
->fieldValueEquals("{$field_name}[0][end_value][date]", '');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][end_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 dates in the UTC timezone.
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, 'UTC');
$end_value = '2013-06-06 00:00:00';
$end_date = new DrupalDateTime($end_value, 'UTC');
// Update the timezone to the system default.
$start_date->setTimezone(timezone_open(date_default_timezone_get()));
$end_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]" => $start_date->format($date_format),
"{$field_name}[0][value][time]" => $start_date->format($time_format),
"{$field_name}[0][end_value][date]" => $end_date->format($date_format),
"{$field_name}[0][end_value][time]" => $end_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($start_date->format($date_format));
$this->assertSession()
->responseContains($start_date->format($time_format));
$this->assertSession()
->responseContains($end_date->format($date_format));
$this->assertSession()
->responseContains($end_date->format($time_format));
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Verify that the default formatter works.
$this->displayOptions['settings'] = [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings;
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long');
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$end_expected = $this->dateFormatter
->format($end_date->getTimestamp(), 'long');
$end_expected_iso = $this->dateFormatter
->format($end_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$end_expected_markup = '<time datetime="' . $end_expected_iso . '">' . $end_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute.");
$this->assertStringContainsString($end_expected_markup, $output, "Formatted date field using long format displayed as {$end_expected} with {$end_expected_iso} attribute.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//div[@data-field-item-attr="foobar"]');
// Verify that the plain formatter works.
$this->displayOptions['type'] = 'daterange_plain';
$this->displayOptions['settings'] = $this->defaultSettings;
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT) . ' - ' . $end_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected}.");
// Verify that the 'datetime_custom' formatter works.
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format']) . ' - ' . $end_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
// Verify that the 'timezone_override' setting works.
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format'], [
'timezone' => 'America/New_York',
]);
$expected .= ' - ' . $end_date->format($this->displayOptions['settings']['date_format'], [
'timezone' => 'America/New_York',
]);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
// Test formatters when start date and end date are the same.
$this->drupalGet('entity_test/add');
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, 'UTC');
$start_date->setTimezone(timezone_open(date_default_timezone_get()));
$date_format = DateFormat::load('html_date')->getPattern();
$time_format = DateFormat::load('html_time')->getPattern();
$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_value][date]" => $start_date->format($date_format),
"{$field_name}[0][end_value][time]" => $start_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->displayOptions = [
'type' => 'daterange_default',
'label' => 'hidden',
'settings' => [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings,
];
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long');
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page');
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//time[@data-field-item-attr="foobar"]');
$this->displayOptions['type'] = 'daterange_plain';
$this->displayOptions['settings'] = $this->defaultSettings;
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected}.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page');
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
$this->assertStringNotContainsString(' THE_SEPARATOR ', $output, 'Separator not found on page');
}
/**
* Tests all-day field.
*/
public function testAlldayRangeField() : void {
$field_name = $this->fieldStorage
->getName();
$field_label = $this->field
->label();
// Ensure field is set to an all-day field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::DATETIME_TYPE_ALLDAY);
$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][end_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]");
$this->assertSession()
->fieldNotExists("{$field_name}[0][end_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 dates in the proper timezone.
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, timezone_open(date_default_timezone_get()));
$end_value = '2013-06-06 23:59:59';
$end_date = new DrupalDateTime($end_value, 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]" => $start_date->format($date_format),
"{$field_name}[0][end_value][date]" => $end_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($start_date->format($date_format));
$this->assertSession()
->responseNotContains($start_date->format($time_format));
$this->assertSession()
->responseContains($end_date->format($date_format));
$this->assertSession()
->responseNotContains($end_date->format($time_format));
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Verify that the default formatter works.
$this->displayOptions['settings'] = [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings;
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long');
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$end_expected = $this->dateFormatter
->format($end_date->getTimestamp(), 'long');
$end_expected_iso = $this->dateFormatter
->format($end_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$end_expected_markup = '<time datetime="' . $end_expected_iso . '">' . $end_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute.");
$this->assertStringContainsString($end_expected_markup, $output, "Formatted date field using long format displayed as {$end_expected} with {$end_expected_iso} attribute.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//div[@data-field-item-attr="foobar"]');
// Verify that the plain formatter works.
$this->displayOptions['type'] = 'daterange_plain';
$this->displayOptions['settings'] = $this->defaultSettings;
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT) . ' - ' . $end_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected}.");
// Verify that the custom formatter works.
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format']) . ' - ' . $end_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
// Verify that the 'timezone_override' setting works.
$this->displayOptions['type'] = 'daterange_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 = $start_date->format($this->displayOptions['settings']['date_format'], [
'timezone' => 'America/New_York',
]);
$expected .= ' - ' . $end_date->format($this->displayOptions['settings']['date_format'], [
'timezone' => 'America/New_York',
]);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
// Test formatters when start date and end date are the same.
$this->drupalGet('entity_test/add');
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, timezone_open(date_default_timezone_get()));
$end_value = '2012-12-31 23:59:59';
$end_date = new DrupalDateTime($end_value, timezone_open(date_default_timezone_get()));
$date_format = DateFormat::load('html_date')->getPattern();
$time_format = DateFormat::load('html_time')->getPattern();
$edit = [
"{$field_name}[0][value][date]" => $start_date->format($date_format),
"{$field_name}[0][end_value][date]" => $start_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->displayOptions = [
'type' => 'daterange_default',
'label' => 'hidden',
'settings' => [
'format_type' => 'long',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings,
];
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$start_expected = $this->dateFormatter
->format($start_date->getTimestamp(), 'long');
$start_expected_iso = $this->dateFormatter
->format($start_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$start_expected_markup = '<time datetime="' . $start_expected_iso . '">' . $start_expected . '</time>';
$end_expected = $this->dateFormatter
->format($end_date->getTimestamp(), 'long');
$end_expected_iso = $this->dateFormatter
->format($end_date->getTimestamp(), 'custom', 'Y-m-d\\TH:i:s\\Z', 'UTC');
$end_expected_markup = '<time datetime="' . $end_expected_iso . '">' . $end_expected . '</time>';
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($start_expected_markup, $output, "Formatted date field using long format displayed as {$start_expected} with {$start_expected_iso} attribute.");
$this->assertStringContainsString($end_expected_markup, $output, "Formatted date field using long format displayed as {$end_expected} with {$end_expected_iso} attribute.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
// Verify that hook_entity_prepare_view can add attributes.
// @see entity_test_entity_prepare_view()
$this->drupalGet('entity_test/' . $id);
$this->assertSession()
->elementExists('xpath', '//div[@data-field-item-attr="foobar"]');
$this->displayOptions['type'] = 'daterange_plain';
$this->container
->get('entity_display.repository')
->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT) . ' THE_SEPARATOR ' . $end_date->format(DateTimeItemInterface::DATETIME_STORAGE_FORMAT);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using plain format displayed as {$expected}.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
$this->displayOptions['type'] = 'daterange_custom';
$this->displayOptions['settings']['date_format'] = 'm/d/Y';
$display_repository->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$expected = $start_date->format($this->displayOptions['settings']['date_format']) . ' THE_SEPARATOR ' . $end_date->format($this->displayOptions['settings']['date_format']);
$output = $this->renderTestEntity($id);
$this->assertStringContainsString($expected, $output, "Formatted date field using daterange_custom format displayed as {$expected}.");
$this->assertStringContainsString(' THE_SEPARATOR ', $output, 'Found proper separator');
}
/**
* Tests Date Range List Widget functionality.
*/
public function testDatelistWidget() : void {
$field_name = $this->fieldStorage
->getName();
$field_label = $this->field
->label();
// Ensure field is set to a date only field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::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' => 'daterange_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\"]");
$this->assertSession()
->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-value-hour\"]");
$this->assertSession()
->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-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 is set to an all day field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::DATETIME_TYPE_ALLDAY);
$this->fieldStorage
->save();
// Change the widget to a datelist widget.
$display_repository->getFormDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle())
->setComponent($field_name, [
'type' => 'daterange_datelist',
'settings' => [
'date_order' => 'YMD',
],
])
->save();
\Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
// Display creation form.
$this->drupalGet('entity_test/add');
// 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\"]");
$this->assertSession()
->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-value-hour\"]");
$this->assertSession()
->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-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', DateRangeItem::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' => 'daterange_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');
foreach ([
'value',
'end-value',
] as $column) {
foreach ([
'year',
'month',
'day',
'hour',
'minute',
'ampm',
] as $element) {
$this->assertSession()
->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-{$column}-{$element}\"]");
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-{$column}-{$element}", '')
->isSelected());
}
}
// Submit a valid date and ensure it is accepted.
$start_date_value = [
'year' => 2012,
'month' => 12,
'day' => 31,
'hour' => 5,
'minute' => 15,
];
$end_date_value = [
'year' => 2013,
'month' => 1,
'day' => 15,
'hour' => 3,
'minute' => 30,
];
$edit = [];
// Add the ampm indicator since we are testing 12 hour time.
$start_date_value['ampm'] = 'am';
$end_date_value['ampm'] = 'pm';
foreach ($start_date_value as $part => $value) {
$edit["{$field_name}[0][value][{$part}]"] = $value;
}
foreach ($end_date_value as $part => $value) {
$edit["{$field_name}[0][end_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());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-year", '2013')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-month", '1')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-day", '15')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-hour", '3')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-minute", '30')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-ampm", 'pm')
->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' => 'daterange_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\"]");
$this->assertSession()
->elementExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-value-hour\"]");
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-hour", '')
->isSelected());
$this->assertSession()
->elementNotExists('xpath', "//*[@id=\"edit-{$field_name}-0-end-value-ampm\"]");
// Submit a valid date and ensure it is accepted.
$start_date_value = [
'year' => 2012,
'month' => 12,
'day' => 31,
'hour' => 17,
'minute' => 15,
];
$end_date_value = [
'year' => 2013,
'month' => 1,
'day' => 15,
'hour' => 3,
'minute' => 30,
];
$edit = [];
foreach ($start_date_value as $part => $value) {
$edit["{$field_name}[0][value][{$part}]"] = $value;
}
foreach ($end_date_value as $part => $value) {
$edit["{$field_name}[0][end_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());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-year", '2013')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-month", '1')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-day", '15')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-hour", '3')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-minute", '30')
->isSelected());
// Test the widget for partial completion of fields.
$display_repository->getFormDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle())
->setComponent($field_name, [
'type' => 'daterange_datelist',
'settings' => [
'increment' => 1,
'date_order' => 'YMD',
'time_type' => '24',
],
])
->save();
\Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
// Test the widget for validation notifications.
foreach (static::datelistDataProvider() as $data) {
[
$start_date_value,
$end_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 ($start_date_value as $part => $value) {
$edit["{$field_name}[0][value][{$part}]"] = $value;
}
foreach ($end_date_value as $part => $value) {
$edit["{$field_name}[0][end_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');
$start_date_value = [
'year' => 2012,
'month' => 12,
'day' => 31,
'hour' => 0,
'minute' => 0,
];
$end_date_value = [
'year' => 2013,
'month' => 1,
'day' => 15,
'hour' => 3,
'minute' => 30,
];
$edit = [];
foreach ($start_date_value as $part => $value) {
$edit["{$field_name}[0][value][{$part}]"] = $value;
}
foreach ($end_date_value as $part => $value) {
$edit["{$field_name}[0][end_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');
$start_date_value = [
'year' => 2012,
'month' => 12,
'day' => 31,
'hour' => 0,
'minute' => 0,
];
$end_date_value = [
'year' => 2013,
'month' => 1,
'day' => 15,
'hour' => 3,
'minute' => 0,
];
$edit = [];
foreach ($start_date_value as $part => $value) {
$edit["{$field_name}[0][value][{$part}]"] = $value;
}
foreach ($end_date_value as $part => $value) {
$edit["{$field_name}[0][end_value][{$part}]"] = $value;
}
$this->submitForm($edit, 'Save');
$this->assertSession()
->statusCodeEquals(200);
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-value-minute", '0')
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists("edit-{$field_name}-0-end-value-minute", '0')
->isSelected());
}
/**
* The data provider for testing the validation of the datelist widget.
*
* @return array
* An array of datelist input permutations to test.
*/
protected static function datelistDataProvider() {
return [
// Year only selected, validation error on Month, Day, Hour, Minute.
[
[
'year' => 2012,
'month' => '',
'day' => '',
'hour' => '',
'minute' => '',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '3',
'minute' => '30',
],
[
'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' => '',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '3',
'minute' => '30',
],
[
'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' => '',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '3',
'minute' => '30',
],
[
'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' => '',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '3',
'minute' => '30',
],
[
'A value must be selected for minute.',
],
],
// Year selected, validation error on Month, Day, Hour, Minute.
[
[
'year' => 2012,
'month' => '12',
'day' => '31',
'hour' => '0',
'minute' => '0',
],
[
'year' => 2013,
'month' => '',
'day' => '',
'hour' => '',
'minute' => '',
],
[
'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' => '31',
'hour' => '0',
'minute' => '0',
],
[
'year' => 2013,
'month' => '1',
'day' => '',
'hour' => '',
'minute' => '',
],
[
'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' => '0',
'minute' => '0',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '',
'minute' => '',
],
[
'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' => '0',
],
[
'year' => 2013,
'month' => '1',
'day' => '15',
'hour' => '3',
'minute' => '',
],
[
'A value must be selected for minute.',
],
],
];
}
/**
* Tests default value functionality.
*/
public function testDefaultValue() : void {
// Create a test content type.
$this->drupalCreateContentType([
'type' => 'date_content',
]);
// Create a field storage with settings to validate.
$field_name = $this->randomMachineName();
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'node',
'type' => 'daterange',
'settings' => [
'datetime_type' => DateRangeItem::DATETIME_TYPE_DATE,
],
]);
$field_storage->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'date_content',
]);
$field->save();
// Set now as default_value.
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => 'now',
'default_value_input[default_end_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 start default value is empty.
$this->assertSession()
->fieldValueEquals('default_value_input[default_date]', '');
$this->assertTrue($this->assertSession()
->optionExists('edit-default-value-input-default-end-date-type', 'now')
->isSelected());
// Check that the relative end default value is empty.
$this->assertSession()
->fieldValueEquals('default_value_input[default_end_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',
'default_end_date_type' => 'now',
'default_end_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', DateTimeItemInterface::STORAGE_TIMEZONE);
$this->assertEquals($expected_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node->get($field_name)
->offsetGet(0)->value);
$this->assertEquals($expected_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node->get($field_name)
->offsetGet(0)->end_value);
// Set an invalid relative default_value to test validation.
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => 'relative',
'default_value_input[default_date]' => 'invalid date',
'default_value_input[default_end_date_type]' => 'relative',
'default_value_input[default_end_date]' => '+1 day',
];
$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 start date value entered is invalid.');
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => 'relative',
'default_value_input[default_date]' => '+1 day',
'default_value_input[default_end_date_type]' => 'relative',
'default_value_input[default_end_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 end date value entered is invalid.');
// Set a relative default_value.
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => 'relative',
'default_value_input[default_date]' => '+45 days',
'default_value_input[default_end_date_type]' => 'relative',
'default_value_input[default_end_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 start default value is displayed.
$this->assertSession()
->fieldValueEquals('default_value_input[default_date]', '+45 days');
$this->assertTrue($this->assertSession()
->optionExists('edit-default-value-input-default-end-date-type', 'relative')
->isSelected());
// Check that the relative end default value is displayed.
$this->assertSession()
->fieldValueEquals('default_value_input[default_end_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' => '+45 days',
'default_end_date_type' => 'relative',
'default_end_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_start_date = new DrupalDateTime('+45 days', DateTimeItemInterface::STORAGE_TIMEZONE);
$expected_end_date = new DrupalDateTime('+90 days', DateTimeItemInterface::STORAGE_TIMEZONE);
$this->assertEquals($expected_start_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node->get($field_name)
->offsetGet(0)->value);
$this->assertEquals($expected_end_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT), $new_node->get($field_name)
->offsetGet(0)->end_value);
// Remove default value.
$field_edit = [
'set_default_value' => '',
'default_value_input[default_date_type]' => '',
'default_value_input[default_end_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 start default value is empty.
$this->assertSession()
->fieldValueEquals('default_value_input[default_date]', '');
$this->assertTrue($this->assertSession()
->optionExists('edit-default-value-input-default-end-date-type', '')
->isSelected());
// Check that the relative end default value is empty.
$this->assertSession()
->fieldValueEquals('default_value_input[default_end_date]', '');
// Check if default_date has been stored successfully.
$config_entity = $this->config('field.field.node.date_content.' . $field_name)
->get();
$this->assertEmpty($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');
// Set now as default_value for start date only.
\Drupal::service('entity_display.repository')->getFormDisplay('node', 'date_content')
->setComponent($field_name, [
'type' => 'datetime_default',
])
->save();
$expected_date = new DrupalDateTime('now', DateTimeItemInterface::STORAGE_TIMEZONE);
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => 'now',
'default_value_input[default_end_date_type]' => '',
];
$this->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
$this->submitForm($field_edit, 'Save settings');
// Make sure only the start value is populated on node add page.
$this->drupalGet('node/add/date_content');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][value][date]", $expected_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT));
$this->assertSession()
->fieldValueEquals("{$field_name}[0][end_value][date]", '');
// Set now as default_value for end date only.
$field_edit = [
'set_default_value' => '1',
'default_value_input[default_date_type]' => '',
'default_value_input[default_end_date_type]' => 'now',
];
$this->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
$this->submitForm($field_edit, 'Save settings');
// Make sure only the start value is populated on node add page.
$this->drupalGet('node/add/date_content');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][value][date]", '');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][end_value][date]", $expected_date->format(DateTimeItemInterface::DATE_STORAGE_FORMAT));
}
/**
* Tests that invalid values are caught and marked as invalid.
*/
public function testInvalidField() : void {
// Change the field to a datetime field.
$this->fieldStorage
->setSetting('datetime_type', DateRangeItem::DATETIME_TYPE_DATETIME);
$this->fieldStorage
->save();
$field_name = $this->fieldStorage
->getName();
$field_label = $this->field
->label();
$this->drupalGet('entity_test/add');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][value][date]", '');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][value][time]", '');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][end_value][date]", '');
$this->assertSession()
->fieldValueEquals("{$field_name}[0][end_value][time]", '');
// Submit invalid start 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',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_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',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12: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',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12: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',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Submit invalid start times and ensure they is not accepted.
$time_value = '';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => $time_value,
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid hour value.
$time_value = '49:00:00';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => $time_value,
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid minutes value.
$time_value = '12:99:00';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => $time_value,
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid seconds value.
$time_value = '12:15:99';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => $time_value,
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Submit invalid end dates and ensure they is not accepted.
$date_value = '';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => $date_value,
"{$field_name}[0][end_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]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => $date_value,
"{$field_name}[0][end_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]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => $date_value,
"{$field_name}[0][end_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]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => $date_value,
"{$field_name}[0][end_value][time]" => '00:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Submit invalid start times and ensure they is not accepted.
$time_value = '';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => $time_value,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid hour value.
$time_value = '49:00:00';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => $time_value,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid minutes value.
$time_value = '12:99:00';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => $time_value,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// Invalid seconds value.
$time_value = '12:15:99';
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => $time_value,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('date is invalid');
// End date before start date.
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2010-12-01',
"{$field_name}[0][end_value][time]" => '12:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('The ' . $field_label . ' end date cannot be before the start date');
// End date before start date.
$edit = [
"{$field_name}[0][value][date]" => '2012-12-01',
"{$field_name}[0][value][time]" => '12:00:00',
"{$field_name}[0][end_value][date]" => '2012-12-01',
"{$field_name}[0][end_value][time]" => '11:00:00',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('The ' . $field_label . ' end date cannot be before the start date');
}
/**
* Tests that 'Date' field storage setting form is disabled if field has data.
*/
public function testDateStorageSettings() : void {
// Create a test content type.
$this->drupalCreateContentType([
'type' => 'date_content',
]);
// Create a field storage with settings to validate.
$field_name = $this->randomMachineName();
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'node',
'type' => 'daterange',
'settings' => [
'datetime_type' => DateRangeItem::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',
$field_name . '[0][end_value][date]' => '2016-04-02',
];
$this->drupalGet('node/add/date_content');
$this->submitForm($edit, 'Save');
$this->drupalGet('admin/structure/types/manage/date_content/fields/node.date_content.' . $field_name);
$this->assertSession()
->elementsCount('xpath', "//*[@name='field_storage[subform][settings][datetime_type]' and contains(@disabled, 'disabled')]", 1);
}
/**
* Tests displaying dates with the 'from_to' setting.
*/
public function testFromSetting() : void {
// Create a test content type.
$this->drupalCreateContentType([
'type' => 'date_content',
]);
foreach (static::fromToSettingDataProvider() as $data) {
$expected = $data['expected'];
$datetime_type = $data['datetime_type'];
$field_formatter_type = $data['field_formatter_type'];
$display_settings = $data[0] ?? [];
$this->doTestFromToSetting($expected, $datetime_type, $field_formatter_type, $display_settings);
}
}
/**
* Performs the test of the 'from_to' setting for given test data.
*/
public function doTestFromToSetting(array $expected, string $datetime_type, string $field_formatter_type, array $display_settings = []) : void {
$field_name = $this->fieldStorage
->getName();
// Ensure the field to a datetime field.
$this->fieldStorage
->setSetting('datetime_type', $datetime_type);
$this->fieldStorage
->save();
// Build up dates in the UTC timezone.
$value = '2012-12-31 00:00:00';
$start_date = new DrupalDateTime($value, 'UTC');
$end_value = '2013-06-06 00:00:00';
$end_date = new DrupalDateTime($end_value, 'UTC');
// Submit a valid date and ensure it is accepted.
$date_format = DateFormat::load('html_date')->getPattern();
$edit = [
"{$field_name}[0][value][date]" => $start_date->format($date_format),
"{$field_name}[0][end_value][date]" => $end_date->format($date_format),
];
// Supply time as well when field is a datetime field.
if ($datetime_type === DateRangeItem::DATETIME_TYPE_DATETIME) {
$time_format = DateFormat::load('html_time')->getPattern();
$edit["{$field_name}[0][value][time]"] = $start_date->format($time_format);
$edit["{$field_name}[0][end_value][time]"] = $end_date->format($time_format);
}
$this->drupalGet('entity_test/add');
$this->submitForm($edit, t('Save'));
preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
$id = $match[1];
$this->assertSession()
->pageTextContains(t('entity_test @id has been created.', [
'@id' => $id,
]));
// Now set display options.
$this->displayOptions = [
'type' => $field_formatter_type,
'label' => 'hidden',
'settings' => $display_settings + [
'format_type' => 'short',
'separator' => 'THE_SEPARATOR',
] + $this->defaultSettings,
];
\Drupal::service('entity_display.repository')->getViewDisplay($this->field
->getTargetEntityTypeId(), $this->field
->getTargetBundle(), 'full')
->setComponent($field_name, $this->displayOptions)
->save();
$output = $this->renderTestEntity($id);
foreach ($expected as $content => $is_expected) {
if ($is_expected) {
$this->assertStringContainsString($content, $output);
}
else {
$this->assertStringNotContainsString($content, $output);
}
}
}
/**
* Provides data for testing the 'from_to' setting.
*
* @return array
* An array of date settings to test the behavior of the 'from_to' setting.
*/
public static function fromToSettingDataProvider() : array {
$datetime_types = [
DateRangeItem::DATETIME_TYPE_DATE => [
'daterange_default' => [
DateTimeRangeConstantsInterface::START_DATE => '12/31/2012',
DateTimeRangeConstantsInterface::END_DATE => '06/06/2013',
],
'daterange_plain' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06',
],
'daterange_custom' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06',
],
],
DateRangeItem::DATETIME_TYPE_DATETIME => [
'daterange_default' => [
DateTimeRangeConstantsInterface::START_DATE => '12/31/2012 - 00:00',
DateTimeRangeConstantsInterface::END_DATE => '06/06/2013 - 00:00',
],
'daterange_plain' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31T00:00:00',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06T00:00:00',
],
'daterange_custom' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31T00:00:00',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06T00:00:00',
],
],
DateRangeItem::DATETIME_TYPE_ALLDAY => [
'daterange_default' => [
DateTimeRangeConstantsInterface::START_DATE => '12/31/2012',
DateTimeRangeConstantsInterface::END_DATE => '06/06/2013',
],
'daterange_plain' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06',
],
'daterange_custom' => [
DateTimeRangeConstantsInterface::START_DATE => '2012-12-31',
DateTimeRangeConstantsInterface::END_DATE => '2013-06-06',
],
],
];
$return = [];
$separator = ' THE_SEPARATOR ';
foreach ($datetime_types as $datetime_type => $field_formatters) {
foreach ($field_formatters as $field_formatter_type => $dates) {
// Both start and end date.
$return[$datetime_type . '-' . $field_formatter_type . '-both'] = [
'expected' => [
$dates[DateTimeRangeConstantsInterface::START_DATE] => TRUE,
$separator => TRUE,
$dates[DateTimeRangeConstantsInterface::END_DATE] => TRUE,
],
'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type,
];
// Only start date.
$return[$datetime_type . '-' . $field_formatter_type . '-start_date'] = [
'expected' => [
$dates[DateTimeRangeConstantsInterface::START_DATE] => TRUE,
$separator => FALSE,
$dates[DateTimeRangeConstantsInterface::END_DATE] => FALSE,
],
'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type,
[
'from_to' => DateTimeRangeConstantsInterface::START_DATE,
],
];
// Only end date.
$return[$datetime_type . '-' . $field_formatter_type . '-end_date'] = [
'expected' => [
$dates[DateTimeRangeConstantsInterface::START_DATE] => FALSE,
$separator => FALSE,
$dates[DateTimeRangeConstantsInterface::END_DATE] => TRUE,
],
'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type,
[
'from_to' => DateTimeRangeConstantsInterface::END_DATE,
],
];
}
}
return $return;
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
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 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 SettingsEditor::rewrite(). | ||||
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. | 40 | |||
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 test environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
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 | Gets the Mink driver args from an environment variable. | 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 test site. | 2 | |||
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::__get | public | function | |||||
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 | ||
DateRangeFieldTest::$defaultSettings | protected | property | The default display settings to use for the formatters. | ||||
DateRangeFieldTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
DateRangeFieldTest::$modules | protected static | property | Modules to install. | Overrides DateTestBase::$modules | |||
DateRangeFieldTest::datelistDataProvider | protected static | function | The data provider for testing the validation of the datelist widget. | ||||
DateRangeFieldTest::doTestFromToSetting | public | function | Performs the test of the 'from_to' setting for given test data. | ||||
DateRangeFieldTest::fromToSettingDataProvider | public static | function | Provides data for testing the 'from_to' setting. | ||||
DateRangeFieldTest::getTestFieldType | protected | function | Returns the type of field to be tested. | Overrides DateTestBase::getTestFieldType | |||
DateRangeFieldTest::testAlldayRangeField | public | function | Tests all-day field. | ||||
DateRangeFieldTest::testDatelistWidget | public | function | Tests Date Range List Widget functionality. | ||||
DateRangeFieldTest::testDateRangeField | public | function | Tests date field functionality. | ||||
DateRangeFieldTest::testDateStorageSettings | public | function | Tests that 'Date' field storage setting form is disabled if field has data. | ||||
DateRangeFieldTest::testDatetimeRangeField | public | function | Tests date and time field. | ||||
DateRangeFieldTest::testDefaultValue | public | function | Tests default value functionality. | ||||
DateRangeFieldTest::testFromSetting | public | function | Tests displaying dates with the 'from_to' setting. | ||||
DateRangeFieldTest::testInvalidField | public | function | Tests that invalid values are caught and marked as invalid. | ||||
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 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 | ||||
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::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 10 | |||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 2 | |||
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. | 1 | |||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when the test installs Drupal. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 28 | |||
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. | 4 | |||
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::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||||
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 | Deprecated | public | function | Callback for random string validation. | |||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 2 | |||
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 | Deprecated | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | Deprecated | protected | function | Check module requirements for the Drupal use case. | |||
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. | 2 | |||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$databasePrefix | protected | property | The database prefix of this test run. | ||||
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::$root | protected | property | The app root. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 4 | |||
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 | Deprecated | public static | function | Returns the database connection to the site under test. | |||
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::$useOneTimeLoginLinks | protected | property | Use one-time login links instead of submitting the login form. | 3 | |||
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. | 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::drupalResetSession | protected | function | Resets the current active session back to Anonymous session. | ||||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.