Replace deprecated usages of entityManager in form classes

Deprecated most of the easy cases, a bunch of usages left that need other services that aren't already injected.

+++ b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php
@@ -48,6 +48,13 @@
 
+  /**
+   * The entity field manager.
+   *
+   * @var \Drupal\Core\Entity\EntityFieldManagerInterface;
+   */
+  protected $entityFieldManager;
+

this seems to be some kind of leftover that's not actually injected or used here as far as I see?

Also not sure why the changes to BlockContentTypeTest were added, that's not a form?

+++ b/core/lib/Drupal/Core/Config/Entity/ConfigDependencyDeleteFormTrait.php
@@ -33,12 +33,12 @@ trait ConfigDependencyDeleteFormTrait {
-   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    *   The entity manager.

"The entity type manager"

This is also not complete yet, there are a few more. I'm expanding it to all form classes, sincde there aren't many more.

find core/ -name "*Form.php" | xargs grep "entityManager-"
core/modules/views_ui/src/Form/BreakLockForm.php:    $account = $this->entityManager->getStorage('user')->load($locked->getOwnerId());
core/modules/config/src/Form/ConfigSingleImportForm.php:      $definition = $this->entityManager->getDefinition($this->data['config_type']);
core/modules/config/src/Form/ConfigSingleImportForm.php:    foreach ($this->entityManager->getDefinitions() as $entity_type => $definition) {
core/modules/config/src/Form/ConfigSingleImportForm.php:      $definition = $this->entityManager->getDefinition($form_state->getValue('config_type'));
core/modules/config/src/Form/ConfigSingleImportForm.php:      $entity_storage = $this->entityManager->getStorage($form_state->getValue('config_type'));
core/modules/config/src/Form/ConfigSingleExportForm.php:    foreach ($this->entityManager->getDefinitions() as $entity_type => $definition) {
core/modules/config/src/Form/ConfigSingleExportForm.php:      $definition = $this->entityManager->getDefinition($form_state->getValue('config_type'));
core/modules/config/src/Form/ConfigSingleExportForm.php:      $entity_storage = $this->entityManager->getStorage($config_type);
core/modules/comment/src/CommentTypeForm.php:      foreach ($this->entityManager->getDefinitions() as $entity_type) {
core/modules/comment/src/CommentTypeForm.php:        '#markup' => $this->entityManager->getDefinition($comment_type->getTargetEntityTypeId())->getLabel(),
core/modules/language/src/Form/ContentLanguageSettingsForm.php:    $entity_types = $this->entityManager->getDefinitions();
core/modules/language/src/Form/ContentLanguageSettingsForm.php:    $bundles = $this->entityManager->getAllBundleInfo();
core/modules/field_ui/src/Form/FieldConfigEditForm.php:    $bundles = $this->entityManager->getBundleInfo($this->entity->getTargetEntityTypeId());
core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php:    return $this->entityManager->getFormModes($this->entity->getTargetEntityTypeId());
core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php:    return $this->entityManager->getFormModeOptions($this->entity->getTargetEntityTypeId());
core/modules/field_ui/src/Form/FieldConfigDeleteForm.php:    $bundles = $this->entityManager->getBundleInfo($this->entity->getTargetEntityTypeId());
core/modules/field_ui/src/Form/FieldStorageAddForm.php:    $entity_type = $this->entityManager->getDefinition($this->entityTypeId);
core/modules/field_ui/src/Form/FieldStorageAddForm.php:        $this->entityManager->getStorage('field_storage_config')->create($field_storage_values)->save();
core/modules/field_ui/src/Form/FieldStorageAddForm.php:        $field = $this->entityManager->getStorage('field_config')->create($field_values);
core/modules/field_ui/src/Form/FieldStorageAddForm.php:        $field = $this->entityManager->getStorage('field_config')->create([
core/modules/field_ui/src/Form/FieldStorageAddForm.php:    foreach ($this->entityManager->getFieldStorageDefinitions($this->entityTypeId) as $field_name => $field_storage) {
core/modules/field_ui/src/Form/FieldStorageAddForm.php:    $field_ids = $this->entityManager->getStorage('field_config')->getQuery()
core/modules/field_ui/src/Form/FieldStorageAddForm.php:    $fields = $this->entityManager->getStorage('field_config')->loadMultiple($field_ids);
core/modules/field_ui/src/Form/FieldStorageAddForm.php:    $field_storage_definitions = $this->entityManager->getFieldStorageDefinitions($this->entityTypeId);
core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php:    return $this->entityManager->getViewModes($this->entity->getTargetEntityTypeId());
core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php:    return $this->entityManager->getViewModeOptions($this->entity->getTargetEntityTypeId());
core/modules/node/src/Form/NodePreviewForm.php:    $view_mode_options = ['full' => $this->t('Full')] + $this->entityManager->getViewModeOptionsByBundle('node', $node->bundle());
core/modules/node/src/NodeTypeForm.php:      $fields = $this->entityManager->getBaseFieldDefinitions('node');
core/modules/node/src/NodeTypeForm.php:      $node = $this->entityManager->getStorage('node')->create(['type' => $type->uuid()]);
core/modules/node/src/NodeTypeForm.php:      $fields = $this->entityManager->getFieldDefinitions('node', $type->id());
core/modules/node/src/NodeTypeForm.php:      $node = $this->entityManager->getStorage('node')->create(['type' => $type->id()]);
core/modules/node/src/NodeTypeForm.php:    $fields = $this->entityManager->getFieldDefinitions('node', $type->id());
core/modules/node/src/NodeTypeForm.php:    $node = $this->entityManager->getStorage('node')->create(['type' => $type->id()]);
core/modules/node/src/NodeTypeForm.php:    $this->entityManager->clearCachedFieldDefinitions();

Some are already being updated in #3025427: Add @trigger_error() to deprecated EntityManager->EntityTypeBundleInfo methods, you might want to skip those or wait on that to get in.

That issue landed, so this could use a reroll, happy to do reviews here.

Ok, still a bunch of forms left however that need to be updated :)

The thing is that forms and some other entity handlers are different and get the entity (type) manager injected through setter methods, so we can't remove the property as it would always be triggered. And I'd rather not remove that method/call.

Doing a grep on all *Form.php files is pretty easy as I did in #9 and we will catch anything we missed as soon as we deprecate the methods entirely.

1. +++ b/core/lib/Drupal/Core/Entity/EntityForm.php
   @@ -441,4 +441,11 @@ public function setEntityTypeManager(EntityTypeManagerInterface $entity_type_man
    
   +  /**
   +   * {@inheritdoc}
   +   */
   +  public function setEntityFieldManager(EntityFieldManagerInterface $entity_field_manager) {
   +    $this->entityFieldManager = $entity_field_manager;
   +    return $this;
   +  }
    }
   

   we should not do this. Instead inject this service to teh specific forms that need it, should only be a few.

2. +++ b/core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php
   @@ -67,14 +67,14 @@ protected function getDefaultPlugin($field_type) {
       */
      protected function getDisplayModes() {
   -    return $this->entityManager->getFormModes($this->entity->getTargetEntityTypeId());
   +    return $this->entityTypeManager->getFormModes($this->entity->getTargetEntityTypeId());
      }
    
      /**
       * {@inheritdoc}
       */
      protected function getDisplayModeOptions() {
   -    return $this->entityManager->getFormModeOptions($this->entity->getTargetEntityTypeId());
   +    return $this->entityTypeManager->getFormModeOptions($this->entity->getTargetEntityTypeId());
      }
   

   this is on the entity display repository, again something that you need to inject through the constructor.

3. +++ b/core/modules/field_ui/src/Form/FieldStorageAddForm.php
   @@ -57,17 +73,24 @@ class FieldStorageAddForm extends FormBase {
        $this->fieldTypePluginManager = $field_type_plugin_manager;
        $this->configFactory = $config_factory;
   +    if (!$this->entity_field_manager) {
   +      @trigger_error('\Drupal\Core\Entity\EntityFieldManagerInterface is a dependency of this class in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/3006851.', E_USER_DEPRECATED);
   +      $entity_field_mananger = \Drupal::service('file_system');
   +    }
   

   wrong service.

+++ b/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php
+++ b/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php
@@ -100,14 +100,14 @@ protected function getDefaultPlugin($field_type) {

@@ -100,14 +100,14 @@ protected function getDefaultPlugin($field_type) {
    * {@inheritdoc}
    */
   protected function getDisplayModes() {
-    return $this->entityTypeManager->getViewModes($this->entity->getTargetEntityTypeId());
+    return $this->entityFieldManager->getViewModes($this->entity->getTargetEntityTypeId());
   }
 
   /**

not entity field manager, entity display repository :)

that's why we shouldn't add a setEntityFieldManager(), there are several new services and each form that used entity manager is likely going to need a different set of replacement services.

+++ b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php
@@ -63,17 +63,17 @@ abstract class EntityDisplayFormBase extends EntityForm {
+    if (!$entity_display_repository) {
+      @trigger_error('\Drupal\Core\Entity\EntityDisplayRepositoryInterface is a dependency of this class in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/2969109.', E_USER_DEPRECATED);
+      $entity_display_repository = \Drupal::service('entity_display.repository');
     }

The format for these messages has changed a few times and is pretty inconsistent but I'd suggest to follow the format that I've used in the last few issues, see for example \Drupal\Core\Entity\Sql\SqlContentEntityStorage::__construct()

1. +++ b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php
   @@ -730,11 +745,11 @@ public function reduceOrder($array, $a) {
      protected function getExtraFields() {
        $context = $this->displayContext == 'view' ? 'display' : $this->displayContext;
   -    $extra_fields = $this->entityManager->getExtraFields($this->entity->getTargetEntityTypeId(), $this->entity->getTargetBundle());
   +    $extra_fields = $this->entityFieldManager->getExtraFields($this->entity->getTargetEntityTypeId(), $this->entity->getTargetBundle());
        return isset($extra_fields[$context]) ? $extra_fields[$context] : [];
   

   Here you correctly still use $this->entityFieldManager, but you removed that now. So that's going to fail. You need to inject both services for it to work.

2. +++ b/core/modules/field_ui/src/Form/FieldStorageAddForm.php
   @@ -57,17 +73,24 @@ class FieldStorageAddForm extends FormBase {
   +    if (!$this->entity_field_manager) {
   +      @trigger_error('\Drupal\Core\Entity\EntityFieldManagerInterface is a dependency of this class in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/2969109.', E_USER_DEPRECATED);
   +      $entity_field_manager = \Drupal::service('entity_field.manager');
   +    }
   +    $this->entityFieldManager = $entity_field_manager;
   

   This should check for $entity_field_manager, not $this->entity_field_manager because that will always be NULL at this point.

3. +++ b/core/modules/field_ui/src/Form/FieldStorageAddForm.php
   @@ -82,7 +105,7 @@ public function getFormId() {
        return new static(
   -      $container->get('entity.manager'),
   +      $container->get('entity_type.manager'),
          $container->get('plugin.manager.field.field_type'),
          $container->get('config.factory')
        );
   

   looks like you're not yet injecting the new entity_field.manager dependency, so that should result in a deprecation messages.

4. +++ b/core/modules/node/src/Form/NodePreviewForm.php
   @@ -35,19 +44,22 @@ class NodePreviewForm extends FormBase {
       */
   -  public function __construct(EntityManagerInterface $entity_manager, ConfigFactoryInterface $config_factory) {
   -    $this->entityManager = $entity_manager;
   +  public function __construct(EntityDisplayRepositoryInterface $entity_display_repository , ConfigFactoryInterface $config_factory) {
   +    $this->entityDisplayRepository = $entity_display_repository;
        $this->configFactory = $config_factory;
   

   This is perfectly fine, actually. The trick here is that EntityManagerInterface/$entity_manager also includes EntityDisplayRepositoryInterface, so if someone still passes in $entity_manager, that will not cause any issues, other than triggering some deprecation messages later on when we finally have @trigger_error()'s in all entity manager methods.

   This is the same as switching entityManager to entityTypeManager, which we also do in a few places.

5. +++ b/core/modules/node/src/NodeTypeForm.php
   @@ -15,22 +17,44 @@
       */
   -  public function __construct(EntityManagerInterface $entity_manager) {
   -    $this->entityManager = $entity_manager;
   +  public function __construct(EntityTypeManagerInterface $entity_type_manager, $entity_field_manager = NULL) {
   +    $this->entityTypeManager = $entity_type_manager;
   +    if (!$this->entity_field_manager) {
   +      @trigger_error('\Drupal\Core\Entity\EntityFieldManagerInterface is a dependency of this class in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/2969109.', E_USER_DEPRECATED);
   +      $entity_field_manager = \Drupal::service('entity_field.manager');
   +    }
   +    $this->entityFieldManager = $entity_field_manager;
      }
   

   $this->entityTypeManager is already set 2 levels up on EntityForm and injected through setEntityTypeManager(), that means you can instead only pass in entity_field.manager as a replacement for entity_manager, like above.

6. +++ b/core/modules/node/src/NodeTypeForm.php
   @@ -252,7 +276,7 @@ public function save(array $form, FormStateInterface $form_state) {
    
   -    $this->entityManager->clearCachedFieldDefinitions();
   +    $this->entityFieldManager->clearCachedFieldDefinitions();
        $form_state->setRedirectUrl($type->toUrl('collection'));
      }
   

   this is most likely unnecessary at this point, but we might not want to change that here.

7. +++ b/core/modules/views_ui/src/Form/BreakLockForm.php
   @@ -32,13 +41,13 @@ class BreakLockForm extends EntityConfirmFormBase {
       */
   -  public function __construct(EntityManagerInterface $entity_manager, SharedTempStoreFactory $temp_store_factory) {
   -    $this->entityManager = $entity_manager;
   +  public function __construct(EntityTypeManagerInterface $entity_type_manager, SharedTempStoreFactory $temp_store_factory) {
   +    $this->entityTypeManager = $entity_type_manager;
        $this->tempStore = $temp_store_factory->get('views');
   

   this one is tricky. same as above, injecting entity type manager here is pointless because it has it already due to being an entity form.

   However, we don't need something else here and it is not the last argument, so removing the argument requires some pretty weird trickery.

   What you'd need to do is remove the argument and remove the type hint from $temp_store_factory, and if that is actaully not a SharedTEmpStorageFactory that means someone passed in an entity manager and we'd need to do a @trigger_error(). Maybe just leave it like this for now...

1. +++ b/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php
   @@ -26,9 +28,13 @@ class FieldLayoutEntityFormDisplayEditForm extends EntityFormDisplayEditForm {
   +  public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, LayoutPluginManagerInterface $layout_plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager) {
   

   the new arguments should use = NULL

2. +++ b/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php
   @@ -26,9 +28,13 @@ class FieldLayoutEntityViewDisplayEditForm extends EntityViewDisplayEditForm {
   +  public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, LayoutPluginManagerInterface $layout_plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager) {
   

   same

3. +++ b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php
   @@ -34,13 +36,27 @@
       */
      protected $fieldTypes;
   -
      /**
       * The entity being used by this form.
   

   that looks wrong.

4. +++ b/core/modules/node/src/NodeTypeForm.php
   @@ -15,22 +16,34 @@
      /**
       * Constructs the NodeTypeForm object.
       *
   -   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   -   *   The entity manager.
   +   * @param \Drupal\Core\Entity\EntityFieldManagerInterface|null $entity_field_manager
   +   *   (optional) The entity field manager.
       */
   -  public function __construct(EntityManagerInterface $entity_manager) {
   -    $this->entityManager = $entity_manager;
   +  public function __construct(EntityFieldManagerInterface $entity_field_manager = NULL) {
   +    if (!$entity_field_manager) {
   +      @trigger_error('Calling NodeTypeForm::__construct() with the $entity_field_manager argument is supported in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/2549139.', E_USER_DEPRECATED);
   +      $entity_field_manager = \Drupal::service('entity_field.manager');
   +    }
   +    $this->entityFieldManager = $entity_field_manager;
   

   BC here shouldn't be necessary, as not a new argument.

5. +++ b/core/tests/Drupal/KernelTests/Core/Entity/EntityDisplayFormBaseTest.php
   @@ -118,7 +118,12 @@ public function testCopyFormValuesToEntity() {
    
   -    $form_object = new EntityViewDisplayEditForm($this->container->get('plugin.manager.field.field_type'), $this->container->get('plugin.manager.field.formatter'));
   +    $form_object = new EntityViewDisplayEditForm(
   +      $this->container->get('plugin.manager.field.field_type'),
   +      $this->container->get('plugin.manager.field.formatter'),
   +      $this->container->get('entity_display.repository'),
   +      $this->container->get('entity_field.manager')
   +    );
        $form_object->setEntityManager($this->container->get('entity.manager'));
        $form_object->setEntity($entity->reveal());
    
   

   we should be able to remove the setEntityManager line below, one thing less to update then for 9.x

According to https://drupal.slack.com/archives/C1BMUQ9U6/p1551867778326000 and the reply from @alexpott, we might still be able to get this in with a deprecation message for 8.7, we're only talking about a bunch of constructors here, not a major new deprecation.

But we have no definitive feedback yet from a release manager. Either way, I think it is RTBC, either #40 or #41 can be committed. #40 to 8.7 + 8.8, #41 only to 8.8.

From slack https://drupal.slack.com/archives/CDDD98AMN/p1552125380214700:

catch: I would say beta is the cut off for deprecation messages targeting 8.7.