diff --git a/src/Element/Styles.php b/src/Element/Styles.php index 1368889eb4aaf24f9892238a3ccf3b21c116c0c4..62a7cf83f8a11991f745a631209ae361d1ab2719 100644 --- a/src/Element/Styles.php +++ b/src/Element/Styles.php @@ -118,7 +118,7 @@ class Styles extends FormElementBase { $sourceManager = static::sourceManager(); $selected = $element['#default_value']['selected'] ?? []; $extra = $element['#default_value']['extra'] ?? ''; - $suffix = ' (' . \t('used') . ')'; + $suffix = static::getAppliedSuffix(); $multipleGroups = (\count($groupedPluginDefinitions) == 1) ? FALSE : TRUE; // Open the root details if specified or if a child has an error. $open = (!empty($element['#open']) || !empty($element['#children_errors'])) ? TRUE : FALSE; @@ -243,6 +243,16 @@ class Styles extends FormElementBase { return $transliterated ?? ''; } + /** + * Get the suffix to indicate a style is applied. + * + * @return string + * The "applied" suffix. + */ + protected static function getAppliedSuffix(): string { + return ' <sup>(<mark>' . \t('applied') . '</mark>)</sup>'; + } + /** * Get selected styles from form values. * diff --git a/src/StylePluginManager.php b/src/StylePluginManager.php index 1b00a082f2df06f8648dfb2315ca37bc82ff4abd..44c5906d740a51b0bbde3de6332799a7bd40a34f 100644 --- a/src/StylePluginManager.php +++ b/src/StylePluginManager.php @@ -253,7 +253,7 @@ class StylePluginManager extends DefaultPluginManager implements StylePluginMana if (\count($grouped_plugin_definitions) == 1) { $multiple_groups = FALSE; } - $suffix = ' (' . $this->t('used') . ')'; + $suffix = ' <sup>(<mark>' . $this->t('applied') . '</mark>)</sup>'; $global_used = $extra; foreach ($grouped_plugin_definitions as $group_plugin_definitions) { $group_used = FALSE; diff --git a/tests/src/Unit/StylePluginManagerTest.php b/tests/src/Unit/StylePluginManagerTest.php index ca24911dd6415895e681fd25f204518e5719349f..23d47300f46c776ce7dc26cd12c8fa3d414b7a74 100644 --- a/tests/src/Unit/StylePluginManagerTest.php +++ b/tests/src/Unit/StylePluginManagerTest.php @@ -403,7 +403,6 @@ class StylePluginManagerTest extends UnitTestCase { * @covers ::alterForm */ public function testAlterForm(): void { - $suffix = ' (used)'; $form = [ '#type' => 'details', '#title' => 'Main', @@ -421,10 +420,10 @@ class StylePluginManagerTest extends UnitTestCase { $this->assertSame('opt2', $altered_form['ui_styles_test1']['#default_value']); $this->assertSame('opt3', $altered_form['ui_styles_test2']['#default_value']); $this->assertSame($this->styles[0]['options'], $altered_form['ui_styles_test1']['#options']); - $this->assertSame($this->styles[0]['label'] . $suffix, $altered_form['ui_styles_test1']['#title']); + $this->assertSame($this->styles[0]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['options'], $altered_form['ui_styles_test2']['#options']); - $this->assertSame($this->styles[1]['label'] . $suffix, $altered_form['ui_styles_test2']['#title']); - $this->assertSame('Main' . $suffix, $altered_form['#title']); + $this->assertSame($this->styles[1]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['ui_styles_test2']['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); // Test that if no value is used suffix is not set. // @phpstan-ignore-next-line @@ -438,12 +437,11 @@ class StylePluginManagerTest extends UnitTestCase { } /** - * Test if used suffix is correctly placed. + * Test if applied suffix is correctly placed. * * @covers ::alterForm */ - public function testUsedSuffix(): void { - $suffix = ' (used)'; + public function testAppliedSuffix(): void { $form = [ '#type' => 'details', '#title' => 'Main', @@ -486,8 +484,8 @@ class StylePluginManagerTest extends UnitTestCase { ], ''); $this->assertArrayHasKey('ui_styles_test1', $altered_form); $this->assertArrayHasKey('ui_styles_test2', $altered_form); - $this->assertSame('Main' . $suffix, $altered_form['#title']); - $this->assertSame($this->styles[0]['label'] . $suffix, $altered_form['ui_styles_test1']['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); + $this->assertSame($this->styles[0]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $altered_form['ui_styles_test2']['#title']); // Value on test2. @@ -498,9 +496,9 @@ class StylePluginManagerTest extends UnitTestCase { ], ''); $this->assertArrayHasKey('ui_styles_test1', $altered_form); $this->assertArrayHasKey('ui_styles_test2', $altered_form); - $this->assertSame('Main' . $suffix, $altered_form['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); $this->assertSame($this->styles[0]['label'], $altered_form['ui_styles_test1']['#title']); - $this->assertSame($this->styles[1]['label'] . $suffix, $altered_form['ui_styles_test2']['#title']); + $this->assertSame($this->styles[1]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['ui_styles_test2']['#title']); // Value on extra. // @phpstan-ignore-next-line @@ -510,7 +508,7 @@ class StylePluginManagerTest extends UnitTestCase { ], 'extra'); $this->assertArrayHasKey('ui_styles_test1', $altered_form); $this->assertArrayHasKey('ui_styles_test2', $altered_form); - $this->assertSame('Main' . $suffix, $altered_form['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); $this->assertSame($this->styles[0]['label'], $altered_form['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $altered_form['ui_styles_test2']['#title']); @@ -556,10 +554,10 @@ class StylePluginManagerTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $altered_form); $this->assertArrayHasKey('ui_styles_test1', $altered_form['main']); $this->assertArrayHasKey('ui_styles_test2', $altered_form['main_2']); - $this->assertSame('Main' . $suffix, $altered_form['#title']); - $this->assertSame('Main' . $suffix, $altered_form['main']['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['main']['#title']); $this->assertSame('Main 2', $altered_form['main_2']['#title']); - $this->assertSame($this->styles[0]['label'] . $suffix, $altered_form['main']['ui_styles_test1']['#title']); + $this->assertSame($this->styles[0]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['main']['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $altered_form['main_2']['ui_styles_test2']['#title']); // Value on test2. @@ -572,11 +570,11 @@ class StylePluginManagerTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $altered_form); $this->assertArrayHasKey('ui_styles_test1', $altered_form['main']); $this->assertArrayHasKey('ui_styles_test2', $altered_form['main_2']); - $this->assertSame('Main' . $suffix, $altered_form['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); $this->assertSame('Main', $altered_form['main']['#title']); - $this->assertSame('Main 2' . $suffix, $altered_form['main_2']['#title']); + $this->assertSame('Main 2' . StylesElementTest::APPLIED_SUFFIX, $altered_form['main_2']['#title']); $this->assertSame($this->styles[0]['label'], $altered_form['main']['ui_styles_test1']['#title']); - $this->assertSame($this->styles[1]['label'] . $suffix, $altered_form['main_2']['ui_styles_test2']['#title']); + $this->assertSame($this->styles[1]['label'] . StylesElementTest::APPLIED_SUFFIX, $altered_form['main_2']['ui_styles_test2']['#title']); // Value on extra. // @phpstan-ignore-next-line @@ -588,7 +586,7 @@ class StylePluginManagerTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $altered_form); $this->assertArrayHasKey('ui_styles_test1', $altered_form['main']); $this->assertArrayHasKey('ui_styles_test2', $altered_form['main_2']); - $this->assertSame('Main' . $suffix, $altered_form['#title']); + $this->assertSame('Main' . StylesElementTest::APPLIED_SUFFIX, $altered_form['#title']); $this->assertSame('Main', $altered_form['main']['#title']); $this->assertSame('Main 2', $altered_form['main_2']['#title']); $this->assertSame($this->styles[0]['label'], $altered_form['main']['ui_styles_test1']['#title']); diff --git a/tests/src/Unit/StylesElementTest.php b/tests/src/Unit/StylesElementTest.php index 11d4bdb1695edad1332f1ebd486f61b298a2aa2b..9902bc28862eda2e07214875eb7a66679f78c1f2 100644 --- a/tests/src/Unit/StylesElementTest.php +++ b/tests/src/Unit/StylesElementTest.php @@ -24,6 +24,8 @@ use Symfony\Component\DependencyInjection\ContainerBuilder; */ class StylesElementTest extends UnitTestCase { + public const APPLIED_SUFFIX = ' <sup>(<mark>applied</mark>)</sup>'; + /** * A list of styles definitions. * @@ -122,7 +124,6 @@ class StylesElementTest extends UnitTestCase { * @covers ::buildForm */ public function testBuildForm(): void { - $suffix = ' (used)'; $formState = new FormState(); $completeForm = []; @@ -144,10 +145,10 @@ class StylesElementTest extends UnitTestCase { $this->assertSame('opt2', $processedElement['wrapper']['ui_styles_test1']['#default_value']); $this->assertSame('opt3', $processedElement['wrapper']['ui_styles_test2']['#default_value']); $this->assertSame($this->styles[0]['options'], $processedElement['wrapper']['ui_styles_test1']['#options']); - $this->assertSame($this->styles[0]['label'] . $suffix, $processedElement['wrapper']['ui_styles_test1']['#title']); + $this->assertSame($this->styles[0]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['options'], $processedElement['wrapper']['ui_styles_test2']['#options']); - $this->assertSame($this->styles[1]['label'] . $suffix, $processedElement['wrapper']['ui_styles_test2']['#title']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); + $this->assertSame($this->styles[1]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['ui_styles_test2']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); // Test that if no value is used suffix is not set. $element = [ @@ -164,12 +165,12 @@ class StylesElementTest extends UnitTestCase { } /** - * Test if used suffix is correctly placed. + * Test if applied suffix is correctly placed. * * @covers ::buildForm + * @covers ::getAppliedSuffix */ - public function testUsedSuffix(): void { - $suffix = ' (used)'; + public function testAppliedSuffix(): void { $formState = new FormState(); $completeForm = []; /** @var \Drupal\ui_styles_test\DummyStylePluginManager $stylesManager */ @@ -223,8 +224,8 @@ class StylesElementTest extends UnitTestCase { $processedElement = Styles::buildForm($element, $formState, $completeForm); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); - $this->assertSame($this->styles[0]['label'] . $suffix, $processedElement['wrapper']['ui_styles_test1']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); + $this->assertSame($this->styles[0]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $processedElement['wrapper']['ui_styles_test2']['#title']); // Value on test2. @@ -241,9 +242,9 @@ class StylesElementTest extends UnitTestCase { $processedElement = Styles::buildForm($element, $formState, $completeForm); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); $this->assertSame($this->styles[0]['label'], $processedElement['wrapper']['ui_styles_test1']['#title']); - $this->assertSame($this->styles[1]['label'] . $suffix, $processedElement['wrapper']['ui_styles_test2']['#title']); + $this->assertSame($this->styles[1]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['ui_styles_test2']['#title']); // Value on extra. $element = [ @@ -260,7 +261,7 @@ class StylesElementTest extends UnitTestCase { $processedElement = Styles::buildForm($element, $formState, $completeForm); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); $this->assertSame($this->styles[0]['label'], $processedElement['wrapper']['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $processedElement['wrapper']['ui_styles_test2']['#title']); @@ -318,10 +319,10 @@ class StylesElementTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']['main']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']['main_2']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['main']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['main']['#title']); $this->assertSame('Main 2', $processedElement['wrapper']['main_2']['#title']); - $this->assertSame($this->styles[0]['label'] . $suffix, $processedElement['wrapper']['main']['ui_styles_test1']['#title']); + $this->assertSame($this->styles[0]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['main']['ui_styles_test1']['#title']); $this->assertSame($this->styles[1]['label'], $processedElement['wrapper']['main_2']['ui_styles_test2']['#title']); // Value on test2. @@ -340,11 +341,11 @@ class StylesElementTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']['main']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']['main_2']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); $this->assertSame('Main', $processedElement['wrapper']['main']['#title']); - $this->assertSame('Main 2' . $suffix, $processedElement['wrapper']['main_2']['#title']); + $this->assertSame('Main 2' . static::APPLIED_SUFFIX, $processedElement['wrapper']['main_2']['#title']); $this->assertSame($this->styles[0]['label'], $processedElement['wrapper']['main']['ui_styles_test1']['#title']); - $this->assertSame($this->styles[1]['label'] . $suffix, $processedElement['wrapper']['main_2']['ui_styles_test2']['#title']); + $this->assertSame($this->styles[1]['label'] . static::APPLIED_SUFFIX, $processedElement['wrapper']['main_2']['ui_styles_test2']['#title']); // Value on extra. $element = [ @@ -363,7 +364,7 @@ class StylesElementTest extends UnitTestCase { $this->assertArrayHasKey('main_2', $processedElement['wrapper']); $this->assertArrayHasKey('ui_styles_test1', $processedElement['wrapper']['main']); $this->assertArrayHasKey('ui_styles_test2', $processedElement['wrapper']['main_2']); - $this->assertSame('Main' . $suffix, $processedElement['wrapper']['#title']); + $this->assertSame('Main' . static::APPLIED_SUFFIX, $processedElement['wrapper']['#title']); $this->assertSame('Main', $processedElement['wrapper']['main']['#title']); $this->assertSame('Main 2', $processedElement['wrapper']['main_2']['#title']); $this->assertSame($this->styles[0]['label'], $processedElement['wrapper']['main']['ui_styles_test1']['#title']);