ContentEntityStorageBase::setNewRevision and ContentEntityStorageBase::setDefaultLangcode don't return $this, making them un-chainable.

They should return $this

CommentFileSizeAuthor
#2 drupal-return_this_from_ContentEntityStorageBase-2839075.patch1.42 KBAaronBauman
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

aaronbauman created an issue. See original summary.

AaronBauman’s picture

AaronBauman
he/him
CreditAttribution: AaronBauman commented
Status: Active » Needs review
FileSize
drupal-return_this_from_ContentEntityStorageBase-2839075.patch1.42 KB

Status: Needs review » Needs work

The last submitted patch, 2: drupal-return_this_from_ContentEntityStorageBase-2839075.patch, failed testing.

cilefen’s picture

cilefen CreditAttribution: cilefen commented
Title: return $this from ContentEntityStorageBase setter methods to make operations chainable » Make ContentEntityStorageBase setter methods fluent
cilefen’s picture

cilefen CreditAttribution: cilefen commented
Issue tags: +Needs release manager review

The title is ContentEntityStorageBase, but don't you mean ContentEntityBase? As far as I know, adding a return where there was not one is allowed by the BC policy, but let's get an opinion.

AaronBauman’s picture

AaronBauman
he/him
CreditAttribution: AaronBauman commented
Title: Make ContentEntityStorageBase setter methods fluent » Make ContentEntityBase setter methods fluent
Status: Needs work » Needs review

Yes, you're right the patch is against ContentEntityBase and RevisionableInterface

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

Drupal 8.3.0-alpha1 will be released the week of January 30, 2017, which means new developments and disruptive changes should now 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.

cilefen’s picture

cilefen CreditAttribution: cilefen commented
Category: Feature request » Task
Issue tags: -Needs release manager review +Needs change record

This is an API improvement that should not break anybody's code. Let's add a tiny change record to alert developers.

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

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now 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.5.x-dev » 8.6.x-dev

Drupal 8.5.0-alpha1 will be released the week of January 17, 2018, which means new developments and disruptive changes should now 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.

borisson_’s picture

borisson_
Primary language Dutch
Location Mechelen, 🇧🇪
CreditAttribution: borisson_ as a volunteer commented

This makes changes to \Drupal\Core\Entity\ContentEntityBase::setNewRevision and \Drupal\Core\Entity\ContentEntityBase::setDefaultLangcode.

I don't think it makes sense to do this for setDefaultLangcode, because that's not part of the public API. I can see why we want to do this for setNewRevision.

joachim’s picture

joachim CreditAttribution: joachim as a volunteer commented
Component: other » entity system

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

Drupal 8.6.0-alpha1 will be released the week of July 16, 2018, which means new developments and disruptive changes should now 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.

jhedstrom’s picture

jhedstrom
Primary language English
Location Portland, OR
CreditAttribution: jhedstrom at Phase2 for Workday, Inc. commented
Status: Needs review » Needs work

Setting to NW for the change record.

Tiny nit:

+++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php
+++ b/core/lib/Drupal/Core/Entity/ContentEntityBase.php
@@ -268,6 +268,7 @@ public function setNewRevision($value = TRUE) {

@@ -268,6 +268,7 @@ public function setNewRevision($value = TRUE) {
     }
 
     $this->newRevision = $value;
+    return $this;

Since this method is defined on the RevisionableInterface, that dockblock should be updated to indicate that the object is returned.

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

Drupal 8.7.0-alpha1 will be released the week of March 11, 2019, which means new developments and disruptive changes should now be targeted against the 8.8.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.8.x-dev » 8.9.x-dev

Drupal 8.8.0-alpha1 will be released the week of October 14th, 2019, which means new developments and disruptive changes should now be targeted against the 8.9.x-dev branch. (Any changes to 8.9.x will also be committed to 9.0.x in preparation for Drupal 9’s release, but some changes like significant feature additions will be deferred to 9.1.x.). 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.1.x-dev

Drupal 8.9.0-beta1 was released on March 20, 2020. 8.9.x is the final, long-term support (LTS) minor release of Drupal 8, which means new developments and disruptive changes should now 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: 9.1.x-dev » 9.2.x-dev

Drupal 9.1.0-alpha1 will be released the week of October 19, 2020, which means new developments and disruptive changes should now be targeted for the 9.2.x-dev branch. For more information see the Drupal 9 minor version schedule and the Allowed changes during the Drupal 9 release cycle.

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

Drupal 9.2.0-alpha1 will be released the week of May 3, 2021, which means new developments and disruptive changes should now be targeted for the 9.3.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.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.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.4.x-dev » 9.5.x-dev

Drupal 9.4.0-alpha1 was released on May 6, 2022, which means new developments and disruptive changes should now 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.

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

Drupal 9.5.0-beta2 and Drupal 10.0.0-beta2 were released on September 29, 2022, which means new developments and disruptive changes should now 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: 10.1.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, which currently accepts only minor-version allowed changes. For more information, see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.