From 19f5bdd1e33dfa382f4735883f64b7e5f51af97c Mon Sep 17 00:00:00 2001
From: Dave Long <dave@longwaveconsulting.com>
Date: Wed, 20 Dec 2023 10:01:30 +0000
Subject: [PATCH] Issue #3409413 by gorkagr, lauriii, longwave: Error
TypeError: Drupal\Core\Field\FieldTypeCategory::getDescription() if a
FieldType has 'description' missing in its annotation
---
.../Core/Field/FallbackFieldTypeCategory.php | 2 +-
core/lib/Drupal/Core/Field/FieldTypeCategory.php | 5 ++---
.../Core/Field/FieldTypeCategoryInterface.php | 10 ++++------
.../src/Plugin/Field/FieldType/TestItem.php | 1 -
.../tests/src/Functional/ManageFieldsTest.php | 14 ++++++++++++++
5 files changed, 21 insertions(+), 11 deletions(-)
diff --git a/core/lib/Drupal/Core/Field/FallbackFieldTypeCategory.php b/core/lib/Drupal/Core/Field/FallbackFieldTypeCategory.php
index d8319d28d501..1794c8b32c57 100644
--- a/core/lib/Drupal/Core/Field/FallbackFieldTypeCategory.php
+++ b/core/lib/Drupal/Core/Field/FallbackFieldTypeCategory.php
@@ -13,7 +13,7 @@ class FallbackFieldTypeCategory extends FieldTypeCategory {
public function __construct(array $configuration, string $plugin_id, array $plugin_definition) {
$plugin_id = $configuration['unique_identifier'];
$plugin_definition = [
- 'label' => $configuration['label'] ?? '',
+ 'label' => $configuration['label'],
'description' => $configuration['description'] ?? '',
'weight' => $configuration['weight'] ?? 0,
] + $plugin_definition;
diff --git a/core/lib/Drupal/Core/Field/FieldTypeCategory.php b/core/lib/Drupal/Core/Field/FieldTypeCategory.php
index 168616102e1b..a0128b1bdf84 100644
--- a/core/lib/Drupal/Core/Field/FieldTypeCategory.php
+++ b/core/lib/Drupal/Core/Field/FieldTypeCategory.php
@@ -3,7 +3,6 @@
namespace Drupal\Core\Field;
use Drupal\Core\Plugin\PluginBase;
-use Drupal\Core\StringTranslation\TranslatableMarkup;
/**
* Default object used for field_type_categories plugins.
@@ -15,14 +14,14 @@ class FieldTypeCategory extends PluginBase implements FieldTypeCategoryInterface
/**
* {@inheritdoc}
*/
- public function getLabel(): TranslatableMarkup {
+ public function getLabel(): string|\Stringable {
return $this->pluginDefinition['label'];
}
/**
* {@inheritdoc}
*/
- public function getDescription(): TranslatableMarkup {
+ public function getDescription(): string|\Stringable {
return $this->pluginDefinition['description'];
}
diff --git a/core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php b/core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php
index 3727df1bb778..e22a07cce0aa 100644
--- a/core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php
+++ b/core/lib/Drupal/Core/Field/FieldTypeCategoryInterface.php
@@ -2,8 +2,6 @@
namespace Drupal\Core\Field;
-use Drupal\Core\StringTranslation\TranslatableMarkup;
-
/**
* Provides an object that returns the category info about the field type.
*/
@@ -12,18 +10,18 @@ interface FieldTypeCategoryInterface {
/**
* Returns the field group label.
*
- * @return \Drupal\Core\StringTranslation\TranslatableMarkup
+ * @return string|\Stringable
* The category label.
*/
- public function getLabel(): TranslatableMarkup;
+ public function getLabel(): string|\Stringable;
/**
* Returns the field group description.
*
- * @return \Drupal\Core\StringTranslation\TranslatableMarkup
+ * @return string|\Stringable
* The category description.
*/
- public function getDescription(): TranslatableMarkup;
+ public function getDescription(): string|\Stringable;
/**
* Returns the field group weight.
diff --git a/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php
index 91beba0e633b..2f64264b54dd 100644
--- a/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php
+++ b/core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php
@@ -14,7 +14,6 @@
* @FieldType(
* id = "test_field",
* label = @Translation("Test field"),
- * description = @Translation("Dummy field type used for tests."),
* default_widget = "test_field_widget",
* default_formatter = "field_test_default"
* )
diff --git a/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php b/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
index 35d8d9ad21dd..e037cb519ef9 100644
--- a/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
+++ b/core/modules/field_ui/tests/src/Functional/ManageFieldsTest.php
@@ -371,4 +371,18 @@ public function testFieldUiDefinitionsAlter() {
$this->assertSession()->pageTextContains('Boolean (overridden by alter)');
}
+ /**
+ * Ensure field category fallback works for field types without a description.
+ */
+ public function testFieldCategoryFallbackWithoutDescription() {
+ $user = $this->drupalCreateUser(['administer node fields']);
+ $node_type = $this->drupalCreateContentType();
+ $this->drupalLogin($user);
+ $this->drupalGet('/admin/structure/types/manage/' . $node_type->id() . '/fields/add-field');
+ $field_type = $this->assertSession()->elementExists('xpath', '//label[text()="Test field"]');
+ $description_container = $field_type->getParent()->find('css', '.field-option__description');
+ $this->assertNotNull($description_container);
+ $this->assertEquals('', $description_container->getText());
+ }
+
}
--
GitLab