Skip to content
Snippets Groups Projects
Commit 50bbdd28 authored by Yash Rode's avatar Yash Rode
Browse files

changed it to enum

parent b737434d
No related branches found
No related tags found
No related merge requests found
...@@ -68,7 +68,7 @@ function datetime_range_entity_view_display_presave(EntityViewDisplayInterface $ ...@@ -68,7 +68,7 @@ function datetime_range_entity_view_display_presave(EntityViewDisplayInterface $
if (!isset($component['settings']['from_to'])) { if (!isset($component['settings']['from_to'])) {
// Existing daterange formatters don't have 'from_to'. // Existing daterange formatters don't have 'from_to'.
$component['settings']['from_to'] = DateTimeRangeConstants::BOTH; $component['settings']['from_to'] = DateTimeRangeConstants::BOTH->value;
$entity_view_display->setComponent($name, $component); $entity_view_display->setComponent($name, $component);
} }
} }
......
...@@ -5,13 +5,13 @@ ...@@ -5,13 +5,13 @@
/** /**
* Declares constants used in the datetime range module. * Declares constants used in the datetime range module.
*/ */
interface DateTimeRangeConstants { enum DateTimeRangeConstants: string {
/** /**
* Values for the 'from_to' formatter setting. * Values for the 'from_to' formatter setting.
*/ */
const BOTH = 'both'; case BOTH = 'both';
const START_DATE = 'start_date'; case START_DATE = 'start_date';
const END_DATE = 'end_date'; case END_DATE = 'end_date';
} }
...@@ -16,7 +16,7 @@ trait DateTimeRangeTrait { ...@@ -16,7 +16,7 @@ trait DateTimeRangeTrait {
*/ */
protected static function dateTimeRangeDefaultSettings() { protected static function dateTimeRangeDefaultSettings() {
return [ return [
'from_to' => DateTimeRangeConstants::BOTH, 'from_to' => DateTimeRangeConstants::BOTH->value,
'separator' => '-', 'separator' => '-',
]; ];
} }
...@@ -73,7 +73,7 @@ protected function dateTimeRangeSettingsForm(array $form, FormStateInterface $fo ...@@ -73,7 +73,7 @@ protected function dateTimeRangeSettingsForm(array $form, FormStateInterface $fo
'#default_value' => $this->getSetting('separator'), '#default_value' => $this->getSetting('separator'),
'#states' => [ '#states' => [
'visible' => [ 'visible' => [
'select[name="fields[' . $field_name . '][settings_edit_form][settings][from_to]"]' => ['value' => DateTimeRangeConstants::BOTH], 'select[name="fields[' . $field_name . '][settings_edit_form][settings][from_to]"]' => ['value' => DateTimeRangeConstants::BOTH->value],
], ],
], ],
]; ];
...@@ -93,7 +93,7 @@ protected function dateTimeRangeSettingsSummary() { ...@@ -93,7 +93,7 @@ protected function dateTimeRangeSettingsSummary() {
} }
} }
if (($separator = $this->getSetting('separator')) && $this->getSetting('from_to') === DateTimeRangeConstants::BOTH) { if (($separator = $this->getSetting('separator')) && $this->getSetting('from_to') === DateTimeRangeConstants::BOTH->value) {
$summary[] = $this->t('Separator: %separator', ['%separator' => $separator]); $summary[] = $this->t('Separator: %separator', ['%separator' => $separator]);
} }
...@@ -108,9 +108,9 @@ protected function dateTimeRangeSettingsSummary() { ...@@ -108,9 +108,9 @@ protected function dateTimeRangeSettingsSummary() {
*/ */
protected function getFromToOptions() { protected function getFromToOptions() {
return [ return [
DateTimeRangeConstants::BOTH => $this->t('Display both start and end dates'), DateTimeRangeConstants::BOTH->value => $this->t('Display both start and end dates'),
DateTimeRangeConstants::START_DATE => $this->t('Display start date only'), DateTimeRangeConstants::START_DATE->value => $this->t('Display start date only'),
DateTimeRangeConstants::END_DATE => $this->t('Display end date only'), DateTimeRangeConstants::END_DATE->value => $this->t('Display end date only'),
]; ];
} }
...@@ -122,8 +122,8 @@ protected function getFromToOptions() { ...@@ -122,8 +122,8 @@ protected function getFromToOptions() {
*/ */
protected function startDateIsDisplayed() { protected function startDateIsDisplayed() {
switch ($this->getSetting('from_to')) { switch ($this->getSetting('from_to')) {
case DateTimeRangeConstants::BOTH: case DateTimeRangeConstants::BOTH->value:
case DateTimeRangeConstants::START_DATE: case DateTimeRangeConstants::START_DATE->value:
return TRUE; return TRUE;
} }
...@@ -138,8 +138,8 @@ protected function startDateIsDisplayed() { ...@@ -138,8 +138,8 @@ protected function startDateIsDisplayed() {
*/ */
protected function endDateIsDisplayed() { protected function endDateIsDisplayed() {
switch ($this->getSetting('from_to')) { switch ($this->getSetting('from_to')) {
case DateTimeRangeConstants::BOTH: case DateTimeRangeConstants::BOTH->value:
case DateTimeRangeConstants::END_DATE: case DateTimeRangeConstants::END_DATE->value:
return TRUE; return TRUE;
} }
...@@ -162,13 +162,13 @@ protected function endDateIsDisplayed() { ...@@ -162,13 +162,13 @@ protected function endDateIsDisplayed() {
protected function renderStartEnd(DrupalDateTime $start_date, string $separator, DrupalDateTime $end_date): array { protected function renderStartEnd(DrupalDateTime $start_date, string $separator, DrupalDateTime $end_date): array {
$element = []; $element = [];
if ($this->startDateIsDisplayed()) { if ($this->startDateIsDisplayed()) {
$element[DateTimeRangeConstants::START_DATE] = $this->buildDate($start_date); $element[DateTimeRangeConstants::START_DATE->value] = $this->buildDate($start_date);
} }
if ($this->startDateIsDisplayed() && $this->endDateIsDisplayed()) { if ($this->startDateIsDisplayed() && $this->endDateIsDisplayed()) {
$element['separator'] = ['#plain_text' => ' ' . $separator . ' ']; $element['separator'] = ['#plain_text' => ' ' . $separator . ' '];
} }
if ($this->endDateIsDisplayed()) { if ($this->endDateIsDisplayed()) {
$element[DateTimeRangeConstants::END_DATE] = $this->buildDate($end_date); $element[DateTimeRangeConstants::END_DATE->value] = $this->buildDate($end_date);
} }
return $element; return $element;
} }
...@@ -189,13 +189,13 @@ protected function renderStartEnd(DrupalDateTime $start_date, string $separator, ...@@ -189,13 +189,13 @@ protected function renderStartEnd(DrupalDateTime $start_date, string $separator,
protected function renderStartEndWithIsoAttribute(DrupalDateTime $start_date, string $separator, DrupalDateTime $end_date): array { protected function renderStartEndWithIsoAttribute(DrupalDateTime $start_date, string $separator, DrupalDateTime $end_date): array {
$element = []; $element = [];
if ($this->startDateIsDisplayed()) { if ($this->startDateIsDisplayed()) {
$element[DateTimeRangeConstants::START_DATE] = $this->buildDateWithIsoAttribute($start_date); $element[DateTimeRangeConstants::START_DATE->value] = $this->buildDateWithIsoAttribute($start_date);
} }
if ($this->startDateIsDisplayed() && $this->endDateIsDisplayed()) { if ($this->startDateIsDisplayed() && $this->endDateIsDisplayed()) {
$element['separator'] = ['#plain_text' => ' ' . $separator . ' ']; $element['separator'] = ['#plain_text' => ' ' . $separator . ' '];
} }
if ($this->endDateIsDisplayed()) { if ($this->endDateIsDisplayed()) {
$element[DateTimeRangeConstants::END_DATE] = $this->buildDateWithIsoAttribute($end_date); $element[DateTimeRangeConstants::END_DATE->value] = $this->buildDateWithIsoAttribute($end_date);
} }
return $element; return $element;
} }
......
...@@ -38,7 +38,7 @@ class DateRangeFieldTest extends DateTestBase { ...@@ -38,7 +38,7 @@ class DateRangeFieldTest extends DateTestBase {
* *
* @var array * @var array
*/ */
protected $defaultSettings = ['timezone_override' => '', 'separator' => '-', 'from_to' => DateTimeRangeConstants::BOTH]; protected $defaultSettings = ['timezone_override' => '', 'separator' => '-', 'from_to' => DateTimeRangeConstants::BOTH->value];
/** /**
* {@inheritdoc} * {@inheritdoc}
...@@ -1507,44 +1507,44 @@ public function fromToSettingDataProvider() { ...@@ -1507,44 +1507,44 @@ public function fromToSettingDataProvider() {
$datetime_types = [ $datetime_types = [
DateRangeItem::DATETIME_TYPE_DATE => [ DateRangeItem::DATETIME_TYPE_DATE => [
'daterange_default' => [ 'daterange_default' => [
DateTimeRangeConstants::START_DATE => '12/31/2012', DateTimeRangeConstants::START_DATE->value => '12/31/2012',
DateTimeRangeConstants::END_DATE => '06/06/2013', DateTimeRangeConstants::END_DATE->value => '06/06/2013',
], ],
'daterange_plain' => [ 'daterange_plain' => [
DateTimeRangeConstants::START_DATE => '2012-12-31', DateTimeRangeConstants::START_DATE->value => '2012-12-31',
DateTimeRangeConstants::END_DATE => '2013-06-06', DateTimeRangeConstants::END_DATE->value => '2013-06-06',
], ],
'daterange_custom' => [ 'daterange_custom' => [
DateTimeRangeConstants::START_DATE => '2012-12-31', DateTimeRangeConstants::START_DATE->value => '2012-12-31',
DateTimeRangeConstants::END_DATE => '2013-06-06', DateTimeRangeConstants::END_DATE->value => '2013-06-06',
], ],
], ],
DateRangeItem::DATETIME_TYPE_DATETIME => [ DateRangeItem::DATETIME_TYPE_DATETIME => [
'daterange_default' => [ 'daterange_default' => [
DateTimeRangeConstants::START_DATE => '12/31/2012 - 00:00', DateTimeRangeConstants::START_DATE->value => '12/31/2012 - 00:00',
DateTimeRangeConstants::END_DATE => '06/06/2013 - 00:00', DateTimeRangeConstants::END_DATE->value => '06/06/2013 - 00:00',
], ],
'daterange_plain' => [ 'daterange_plain' => [
DateTimeRangeConstants::START_DATE => '2012-12-31T00:00:00', DateTimeRangeConstants::START_DATE->value => '2012-12-31T00:00:00',
DateTimeRangeConstants::END_DATE => '2013-06-06T00:00:00', DateTimeRangeConstants::END_DATE->value => '2013-06-06T00:00:00',
], ],
'daterange_custom' => [ 'daterange_custom' => [
DateTimeRangeConstants::START_DATE => '2012-12-31T00:00:00', DateTimeRangeConstants::START_DATE->value => '2012-12-31T00:00:00',
DateTimeRangeConstants::END_DATE => '2013-06-06T00:00:00', DateTimeRangeConstants::END_DATE->value => '2013-06-06T00:00:00',
], ],
], ],
DateRangeItem::DATETIME_TYPE_ALLDAY => [ DateRangeItem::DATETIME_TYPE_ALLDAY => [
'daterange_default' => [ 'daterange_default' => [
DateTimeRangeConstants::START_DATE => '12/31/2012', DateTimeRangeConstants::START_DATE->value => '12/31/2012',
DateTimeRangeConstants::END_DATE => '06/06/2013', DateTimeRangeConstants::END_DATE->value => '06/06/2013',
], ],
'daterange_plain' => [ 'daterange_plain' => [
DateTimeRangeConstants::START_DATE => '2012-12-31', DateTimeRangeConstants::START_DATE->value => '2012-12-31',
DateTimeRangeConstants::END_DATE => '2013-06-06', DateTimeRangeConstants::END_DATE->value => '2013-06-06',
], ],
'daterange_custom' => [ 'daterange_custom' => [
DateTimeRangeConstants::START_DATE => '2012-12-31', DateTimeRangeConstants::START_DATE->value => '2012-12-31',
DateTimeRangeConstants::END_DATE => '2013-06-06', DateTimeRangeConstants::END_DATE->value => '2013-06-06',
], ],
], ],
]; ];
...@@ -1556,9 +1556,9 @@ public function fromToSettingDataProvider() { ...@@ -1556,9 +1556,9 @@ public function fromToSettingDataProvider() {
// Both start and end date. // Both start and end date.
$return[$datetime_type . '-' . $field_formatter_type . '-both'] = [ $return[$datetime_type . '-' . $field_formatter_type . '-both'] = [
'expected' => [ 'expected' => [
$dates[DateTimeRangeConstants::START_DATE] => TRUE, $dates[DateTimeRangeConstants::START_DATE->value] => TRUE,
$separator => TRUE, $separator => TRUE,
$dates[DateTimeRangeConstants::END_DATE] => TRUE, $dates[DateTimeRangeConstants::END_DATE->value] => TRUE,
], ],
'datetime_type' => $datetime_type, 'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type, 'field_formatter_type' => $field_formatter_type,
...@@ -1567,25 +1567,25 @@ public function fromToSettingDataProvider() { ...@@ -1567,25 +1567,25 @@ public function fromToSettingDataProvider() {
// Only start date. // Only start date.
$return[$datetime_type . '-' . $field_formatter_type . '-start_date'] = [ $return[$datetime_type . '-' . $field_formatter_type . '-start_date'] = [
'expected' => [ 'expected' => [
$dates[DateTimeRangeConstants::START_DATE] => TRUE, $dates[DateTimeRangeConstants::START_DATE->value] => TRUE,
$separator => FALSE, $separator => FALSE,
$dates[DateTimeRangeConstants::END_DATE] => FALSE, $dates[DateTimeRangeConstants::END_DATE->value] => FALSE,
], ],
'datetime_type' => $datetime_type, 'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type, 'field_formatter_type' => $field_formatter_type,
['from_to' => DateTimeRangeConstants::START_DATE], ['from_to' => DateTimeRangeConstants::START_DATE->value],
]; ];
// Only end date. // Only end date.
$return[$datetime_type . '-' . $field_formatter_type . '-end_date'] = [ $return[$datetime_type . '-' . $field_formatter_type . '-end_date'] = [
'expected' => [ 'expected' => [
$dates[DateTimeRangeConstants::START_DATE] => FALSE, $dates[DateTimeRangeConstants::START_DATE->value] => FALSE,
$separator => FALSE, $separator => FALSE,
$dates[DateTimeRangeConstants::END_DATE] => TRUE, $dates[DateTimeRangeConstants::END_DATE->value] => TRUE,
], ],
'datetime_type' => $datetime_type, 'datetime_type' => $datetime_type,
'field_formatter_type' => $field_formatter_type, 'field_formatter_type' => $field_formatter_type,
['from_to' => DateTimeRangeConstants::END_DATE], ['from_to' => DateTimeRangeConstants::END_DATE->value],
]; ];
} }
} }
......
...@@ -82,13 +82,13 @@ public function testFromToSeparatorState() { ...@@ -82,13 +82,13 @@ public function testFromToSeparatorState() {
// Assert that date separator field is visible if 'from_to' is set to // Assert that date separator field is visible if 'from_to' is set to
// BOTH. // BOTH.
$this->assertSession()->fieldValueEquals($from_to_locator, DateTimeRangeConstants::BOTH); $this->assertSession()->fieldValueEquals($from_to_locator, DateTimeRangeConstants::BOTH->value);
$this->assertTrue($separator->isVisible()); $this->assertTrue($separator->isVisible());
// Assert that the date separator is not visible if 'from_to' is set to // Assert that the date separator is not visible if 'from_to' is set to
// START_DATE or END_DATE. // START_DATE or END_DATE.
$page->selectFieldOption($from_to_locator, DateTimeRangeConstants::START_DATE); $page->selectFieldOption($from_to_locator, DateTimeRangeConstants::START_DATE->value);
$this->assertFalse($separator->isVisible()); $this->assertFalse($separator->isVisible());
$page->selectFieldOption($from_to_locator, DateTimeRangeConstants::END_DATE); $page->selectFieldOption($from_to_locator, DateTimeRangeConstants::END_DATE->value);
$this->assertFalse($separator->isVisible()); $this->assertFalse($separator->isVisible());
} }
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment