Problem/Motivation

Follow-up to #2577785-3: Remove PlaceholderTrait

  protected static function placeholderFormat($string, array $args) {

$arguments is more consistant,
and placeholderFormat needs a better name.

Proposed resolution

Rename placeholderFormat() to replacePlaceholders() and the argument $args to $arguments

(note will conflict with #2580505: Improve FormattableMarkup documentation, which is fine, one or the other can be rerolled depending on which goes in first.)

Remaining tasks

Contributor tasks needed
Task Novice task? Contributor instructions Complete?
Create a patch Instructions
Update the patch to incorporate feedback from reviews (include an interdiff) Instructions
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards Instructions

User interface changes

No

API changes

Yes

Data model changes

No

CommentFileSizeAuthor
#12 interdiff-2580525-7-12.txt2.47 KBmarvin_b8
#12 2580525-12.patch13.63 KBmarvin_b8
#7 2580525-7.patch14.17 KBmarvin_b8
#7 interdiff-2580525-5-7.txt761 bytesmarvin_b8
#5 interdiff-2580525-2-5.txt2.69 KBmarvin_b8
#5 2580525-5.patch14.6 KBmarvin_b8
#2 2580525-2.patch14.14 KByesct

Comments

YesCT created an issue. See original summary.

yesct’s picture

yesct commented
Title: Rename placeholderFormat() and the argument args » Rename placeholderFormat() to replacePlaceholders() and the argument args to arguments
Issue summary: View changes
StatusFileSize
new 2580525-2.patch14.14 KB

used "refactor" to do this (hopefully means didn't miss anything that way)

checked that changes didn't cause any 80 char re-wrapping needed.

yesct’s picture

yesct commented
Status: Active » Needs review
yesct’s picture

yesct commented
Status: Needs review » Needs work

cause of where we are in release cycle, this needs to keep the old one around as a wrapper, and be marked deprecated so there are no BC API breaks.

marvin_b8’s picture

marvin_b8 commented
Status: Needs work » Needs review
StatusFileSize
new 2580525-5.patch14.6 KB
new interdiff-2580525-2-5.txt2.69 KB

is that ok ?

dawehner’s picture

dawehner
Primary language German
commented 
  1. +++ b/core/lib/Drupal/Component/Render/FormattableMarkup.php
@@ -229,14 +229,24 @@ protected static function placeholderFormat($string, array $args) {
+  ¶
...
+  ¶

    Here is a little bit of whitespace 

  2. +++ b/core/lib/Drupal/Component/Render/FormattableMarkup.php
@@ -229,14 +229,24 @@ protected static function placeholderFormat($string, array $args) {
+  /**
+   * Replaces placeholders in a string with values.
+   *
+   * @deprecated in Drupal 8.0.x-dev, will be removed before Drupal 9.0.0.
+   *   Use \Drupal\Component\Render\FormattableMarkup:replacePlaceholders().
+   */
+  protected static function placeholderFormat($string, array $arguments) {
+    return static::replacePlaceholders($string,$arguments);
+  }

    Given that we deal with a protected method I think its okay to not have a BC layer

marvin_b8’s picture

marvin_b8 commented
StatusFileSize
new interdiff-2580525-5-7.txt761 bytes
new 2580525-7.patch14.17 KB

ok, i have remove the bc layer.

dawehner’s picture

dawehner
Primary language German
commented
Status: Needs review » Reviewed & tested by the community

Cool, thank you!

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 7: 2580525-7.patch, failed testing.

marvin_b8’s picture

marvin_b8 commented
Status: Needs work » Reviewed & tested by the community

Status: Reviewed & tested by the community » Needs work

The last submitted patch, 7: 2580525-7.patch, failed testing.

marvin_b8’s picture

marvin_b8 commented
Status: Needs work » Needs review
Issue tags: +rc eligible
StatusFileSize
new 2580525-12.patch13.63 KB
new interdiff-2580525-7-12.txt2.47 KB

Status: Needs review » Needs work

The last submitted patch, 12: 2580525-12.patch, failed testing.

marvin_b8’s picture

marvin_b8 commented
Status: Needs work » Needs review
dawehner’s picture

dawehner
Primary language German
commented 
+++ b/core/lib/Drupal/Core/StringTranslation/PluralTranslatableMarkup.php
index 024c3a4..84fec1f 100644
--- a/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php

--- a/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php
+++ b/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php

+++ b/core/lib/Drupal/Core/StringTranslation/TranslatableMarkup.php
@@ -205,7 +205,7 @@ public function render() {
-      return $this->placeholderFormat($this->translatedMarkup, $args);
+      return $this->replacePlaceholders($this->translatedMarkup, $args);

This is a question, given that this protected method is used in more places, I'm curious whether we should keep a quick BC layer?

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

smustgrave’s picture

smustgrave commented
Status: Needs review » Postponed

https://www.drupal.org/project/drupal/issues/2580505 appears closer then this so postponing this for now. Once the other lands this can be rerolled (which is needed)

Version: 9.4.x-dev » 9.5.x-dev

Drupal 9.4.9 was released on December 7, 2022 and is the final full bugfix release for the Drupal 9.4.x series. Drupal 9.4.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.5.x-dev branch from now on, and new development or disruptive changes should be targeted for the 10.1.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.5.x-dev » 11.x-dev

Drupal core is moving towards using a “main” branch. As an interim step, a new 11.x branch has been opened, as Drupal.org infrastructure cannot currently fully support a branch named main. New developments and disruptive changes should now be targeted for the 11.x branch. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 11.x-dev » main

Drupal core is now using the main branch as the primary development branch. New developments and disruptive changes should now be targeted to the main branch.

Read more in the announcement.