Replace deprecated usage of entity_create('contact_form') with a direct call to ContactForm::create() [#2641520]

Follow-up to #2490966: [Meta] Replace deprecated usage of entity_create with a direct call to the entity type class

Problem/Motivation

According to #2346261: Deprecate entity_create() in favor of a <EntityType>::create($values) or \Drupal::entityManager()->getStorage($entity_type)->create($values), entity_create() function is going to be deprecated so we shouldn't use it anymore. When the entity type is known we should directly call <EntityType>::create(). What to do when the entity type is not known or is variable is upon discussions.

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category	Task
Issue priority	Normal because it's just about code cleanup and good practices
Prioritized changes	The main goal of this issue is DX, performance and removing code already deprecated for 8.0.0. (Direct calls to EntityType::create are better than generic calls to entity_create for readability)
Disruption	This change is not disruptive at all as it only replaces deprecated functions call by their exact equivalent.

Proposed resolution

Replace the deprecated call to entity_create() by a proper call to <EntityType>::create().

Before:

entity_create('field_config', $field_values)->save();

After:

use Drupal\field\Entity\FieldConfig;
FieldConfig::create($field_values)->save();

Remaining tasks

Contributor tasks needed
Task	Novice task?	Contributor instructions	Complete?
Create a patch		Instructions	Done
Manually test the patch	Novice	Instructions
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards		Instructions

User interface changes

None.

API changes

None.

Comment	File	Size	Author
#29	2641520-26.patch	1.94 KB	Mile23
#29	8.1.x: PHP 5.5 & MySQL 5.5 18,777 pass
#26	2641520-26.patch	1.94 KB	rakesh.gectcr
#26
#23	2641520-19.patch	2 KB	rakesh.gectcr
#23	8.1.x: PHP 5.5 & MySQL 5.5 1 fail
#20	2599454-19.patch	6.62 KB	rakesh.gectcr
#20	8.1.x: PHP 5.5 & MySQL 5.5 1 fail
#13	2641520-replace-deprecated-usage-entity_create-with-a-direct-call-to-contactform_create.patch	1.88 KB	darkdim
#13	8.1.x: PHP 5.5 & MySQL 5.5 1 fail PHP 5.6 & MySQL 5.5 1 fail
#10	contact_form-2641520-10.patch	2.29 KB	Mac_Weber
#10	8.1.x: PHP 5.5 & MySQL 5.5 14,456 pass
#5	contact_form-2641520-5.patch	2.29 KB	Mac_Weber
#5	8.1.x: PHP 5.5 & MySQL 5.5 1 fail
#2	contact_form-2641520-2.patch	2.3 KB	Mac_Weber
#2	8.1.x: PHP 5.5 & MySQL 5.5 14,439 pass, 4 fail

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

28 December 2015 at 18:47

Mac_Weber created an issue. See original summary.

Comment #2

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 28 December 2015 at 18:49

Status:	Active	» Needs review
Parent issue:	#2641506: Replace deprecated usage of entity_create('config_query_test') with a direct call to ConfigQueryTest::create()	» #2490966: [Meta] Replace deprecated usage of entity_create with a direct call to the entity type class

File	Size
contact_form-2641520-2.patch	2.3 KB
8.1.x: PHP 5.5 & MySQL 5.5 14,439 pass, 4 fail

Comment #3

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 28 December 2015 at 18:56

Issue summary:

View changes

Comment #4

28 December 2015 at 19:23

Status:

Needs review

» Needs work

The last submitted patch, 2: contact_form-2641520-2.patch, failed testing.

Comment #5

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 29 December 2015 at 01:58

Status:

Needs work

» Needs review

File	Size
contact_form-2641520-5.patch	2.29 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail

1 file was hidden/shown/deleted

File	Size
contact_form-2641520-2.patch	2.3 KB
8.1.x: PHP 5.5 & MySQL 5.5 14,439 pass, 4 fail

Fixed class aliasing

Comment #6

jibran

he/him

Urdu

Sydney, Australia

CreditAttribution: jibran commented 30 December 2015 at 06:18

Status:

Needs review

» Reviewed & tested by the community

Comment #7

30 December 2015 at 06:24

Status:

Reviewed & tested by the community

» Needs work

The last submitted patch, 5: contact_form-2641520-5.patch, failed testing.

Comment #8

30 December 2015 at 14:31

The last submitted patch, 5: contact_form-2641520-5.patch, failed testing.

Comment #9

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 30 December 2015 at 23:11

Issue tags:

++Needs reroll

I think I can reroll it myself by tomorrow

Comment #10

Mac_Weber CreditAttribution: Mac_Weber as a volunteer commented 2 January 2016 at 16:10

Status:	Needs work	» Needs review
Issue tags:	-+Needs reroll

File	Size
contact_form-2641520-10.patch	2.29 KB
8.1.x: PHP 5.5 & MySQL 5.5 14,456 pass

Rerolled

Comment #11

Xano

he/they

English

Southampton

CreditAttribution: Xano at Druid commented 4 January 2016 at 14:41

Status:

Needs review

» Needs work

```
+++ b/core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
@@ -211,7 +212,7 @@ public function doCustomContentTypeListTest() {
+    $contact_form = ContactForm::create(array(
```
This should use $this->container->get('entity_type.manager')->getStorage('contact_form')->create(). Using the static ::create() method on entity classes is for procedural code only, because such code does not support this kind of dependency injection.

+++ b/core/modules/contact/src/Tests/Views/ContactFieldsTest.php
@@ -40,7 +41,7 @@ protected function setUp() {
+    ContactForm::create(array(

Same here.

Comment #12

darkdim

English

Kyiv

CreditAttribution: darkdim as a volunteer commented 31 January 2016 at 13:56

Assigned:	Unassigned	» darkdim
Issue tags:		+CodeSprintUA

Comment #13

darkdim

English

Kyiv

CreditAttribution: darkdim as a volunteer commented 31 January 2016 at 14:07

File	Size
2641520-replace-deprecated-usage-entity_create-with-a-direct-call-to-contactform_create.patch	1.88 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail PHP 5.6 & MySQL 5.5 1 fail

done

Comment #14

darkdim

English

Kyiv

CreditAttribution: darkdim as a volunteer commented 31 January 2016 at 14:08

Assigned:	darkdim	» Unassigned
Status:	Needs work	» Needs review
Issue tags:		+SprintWeekend2016

Comment #15

31 January 2016 at 14:17

Status:

Needs review

» Needs work

The last submitted patch, 13: 2641520-replace-deprecated-usage-entity_create-with-a-direct-call-to-contactform_create.patch, failed testing.

Comment #16

andypost

he/him

Russian

CreditAttribution: andypost as a volunteer and at Skilld commented 3 February 2016 at 10:11

2 files were hidden/shown/deleted

File	Size
contact_form-2641520-5.patch	2.29 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail
contact_form-2641520-10.patch	2.29 KB
8.1.x: PHP 5.5 & MySQL 5.5 14,456 pass

+++ b/core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
@@ -11,6 +11,7 @@
+use Drupal\contact\Entity\ContactForm;

+++ b/core/modules/contact/src/Tests/Views/ContactFieldsTest.php
@@ -8,6 +8,7 @@
+use Drupal\contact\Entity\ContactForm;

useless use...

Comment #17

rakesh.gectcr

he/him

Malayalam

Manchester

CreditAttribution: rakesh.gectcr as a volunteer and at Valuebound commented 12 February 2016 at 20:04

Assigned:

Unassigned

» rakesh.gectcr

Comment #18

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett at Acquia commented 12 February 2016 at 20:09

+++ b/core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
@@ -11,6 +11,7 @@
+use Drupal\contact\Entity\ContactForm;

@@ -210,7 +211,7 @@ public function doCustomContentTypeListTest() {
-    $contact_form = entity_create('contact_form', array(
+    $contact_form = $this->container->get('entity_type.manager')->getStorage('contact_form')->create(array(

Which is it? Why not just use ContactForm::create?

Comment #19

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett at Acquia commented 12 February 2016 at 20:15

Ignore #11, that's wrong. We didn't do that in any of the other ::create conversion issues.

Comment #20

rakesh.gectcr

he/him

Malayalam

Manchester

CreditAttribution: rakesh.gectcr as a volunteer and at Valuebound commented 12 February 2016 at 20:47

Status:

Needs work

» Needs review

File	Size
2599454-19.patch	6.62 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail

1 file was hidden/shown/deleted

File	Size
2641520-replace-deprecated-usage-entity_create-with-a-direct-call-to-contactform_create.patch	1.88 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail PHP 5.6 & MySQL 5.5 1 fail

@tim.plunkett, Thanks for the help in IRC.

I have re rolled the patch, Please review it.

Comment #21

rakesh.gectcr

he/him

Malayalam

Manchester

CreditAttribution: rakesh.gectcr as a volunteer and at Valuebound commented 12 February 2016 at 20:48

Status:

Needs review

» Needs work

1 file was hidden/shown/deleted

File	Size
2599454-19.patch	6.62 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail

Wrong Patch attched

Comment #22

12 February 2016 at 20:50

The last submitted patch, 20: 2599454-19.patch, failed testing.

Comment #23

rakesh.gectcr

he/him

Malayalam

Manchester

CreditAttribution: rakesh.gectcr as a volunteer and at Valuebound commented 12 February 2016 at 20:52

Status:

Needs work

» Needs review

File	Size
2641520-19.patch	2 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail

Comment #24

12 February 2016 at 20:54

Status:

Needs review

» Needs work

The last submitted patch, 23: 2641520-19.patch, failed testing.

Comment #25

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett at Acquia commented 12 February 2016 at 21:28

+++ b/core/modules/config_translation/src/Tests/ConfigTranslationListUiTest.php
@@ -210,10 +211,10 @@ public function doCustomContentTypeListTest() {
-      'id' => Unicode::strtolower($this->randomMachineName(16)),
...
+      'id'=> Unicode::strtolower($this->randomMachineName(16)),

Please restore the space after 'id'

Also the patch fail says it does not apply.
Are you rolling it against 8.1.x?

Comment #26

rakesh.gectcr

he/him

Malayalam

Manchester

CreditAttribution: rakesh.gectcr as a volunteer and at Valuebound commented 12 February 2016 at 21:57

Status:

Needs work

» Needs review

File	Size
2641520-26.patch	1.94 KB

1 file was hidden/shown/deleted

File	Size
2641520-19.patch	2 KB
8.1.x: PHP 5.5 & MySQL 5.5 1 fail

Sorry, The previous one i did against 8.0.x,

The latest patch I rolled against 8.1.x, Please review it

Comment #27

Mile23

English

Seattle, WA

CreditAttribution: Mile23 as a volunteer commented 15 February 2016 at 02:23

Status:

Needs review

» Reviewed & tested by the community

The patch in #26 applies, and does the job of replacing all occurrences of entity_load('contact_form with ContactForm::create().

Setting RTBC.

Comment #28

catch

he/him

English

CreditAttribution: catch at Third and Grove commented 15 February 2016 at 03:15

Status:

Reviewed & tested by the community

» Needs review

Seeing if I can persuade the bot to test #26.

Comment #29

Mile23

English

Seattle, WA

CreditAttribution: Mile23 as a volunteer commented 15 February 2016 at 06:22

File	Size
2641520-26.patch	1.94 KB
8.1.x: PHP 5.5 & MySQL 5.5 18,777 pass

Hmm. Don't see it going.

Here's a re-upload of the file. All credit to @rakesh.gectcr #26.

RTBC if it passes. :-)

Comment #30

catch

he/him

English

CreditAttribution: catch at Third and Grove commented 15 February 2016 at 06:23

Status:

Needs review

» Reviewed & tested by the community

Comment #31

15 February 2016 at 07:36

catch committed 3f6c974 on 8.1.x

Issue #2641520 by Mac_Weber, rakesh.gectcr, darkdim: Replace deprecated...

Comment #32

catch

he/him

English

CreditAttribution: catch at Third and Grove commented 15 February 2016 at 07:37

Status:

Reviewed & tested by the community

» Fixed

Committed/pushed to 8.1.x, thanks!

Comment #33

29 February 2016 at 07:44

Status:

Fixed

» Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

Replace deprecated usage of entity_create('contact_form') with a direct call to ContactForm::create()

Problem/Motivation

Beta phase evaluation

Proposed resolution

Remaining tasks

User interface changes

API changes

Comments

Parent issue