Skip to content

Add stubs for daterange field type #786

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions stubs/Drupal/datetime/Plugin/Field/FieldType/DateTimeItem.stub
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<?php

namespace Drupal\datetime\Plugin\Field\FieldType;

use Drupal\Core\Field\FieldItemBase;

/**
* @property ?string $value
* @property ?\Drupal\Core\Datetime\DrupalDateTime $date
*/
class DateTimeItem extends FieldItemBase implements DateTimeItemInterface {

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<?php

namespace Drupal\datetime\Plugin\Field\FieldType;

interface DateTimeItemInterface {
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace Drupal\datetime_range\Plugin\Field\FieldType;

use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;

/**
* @property null $date
* Even though this extends DateTimeItem, the date property does not actually
* exist. It is not possible to undo a property definition.
* @property ?\Drupal\Core\Datetime\DrupalDateTime $start_date
* @property ?string $end_value
* @property ?\Drupal\Core\Datetime\DrupalDateTime $end_date
*/
class DateRangeItem extends DateTimeItem {

}
18 changes: 18 additions & 0 deletions tests/src/Type/data/field-types.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
use Drupal\Core\Field\Plugin\Field\FieldType\TimestampItem;
use Drupal\Core\Field\Plugin\Field\FieldType\UriItem;
use Drupal\Core\Field\Plugin\Field\FieldType\UuidItem;
use Drupal\datetime\Plugin\Field\FieldType\DateTimeItem;
use Drupal\datetime_range\Plugin\Field\FieldType\DateRangeItem;
use Drupal\file\Plugin\Field\FieldType\FileItem;
use Drupal\file\Plugin\Field\FieldType\FileUriItem;
use Drupal\link\Plugin\Field\FieldType\LinkItem;
Expand Down Expand Up @@ -137,6 +139,22 @@
assertType(UuidItem::class, $uuid_field);
assertType('string', $uuid_field->value);

// DateTimeItem.
$datetime_field = $node->get('field_datetime')->first();
assert($datetime_field instanceof DateTimeItem);
assertType(DateTimeItem::class, $datetime_field);
assertType('string|null', $datetime_field->value);
assertType('Drupal\Core\Datetime\DrupalDateTime|null', $datetime_field->date);

// DateRangeItem.
$daterange_field = $node->get('field_daterange')->first();
assert($daterange_field instanceof DateRangeItem);
assertType(DateRangeItem::class, $daterange_field);
assertType('string|null', $daterange_field->value);
assertType('Drupal\Core\Datetime\DrupalDateTime|null', $daterange_field->start_date);
assertType('string|null', $daterange_field->end_value);
assertType('Drupal\Core\Datetime\DrupalDateTime|null', $daterange_field->end_date);

// FileItem.
$file_field = $node->get('field_file')->first();
assert($file_field instanceof FileItem);
Expand Down
Loading