By plach on
Change record status: 
Published (View all published change records)
Project: 
Drupal core
Introduced in branch: 
8.5.x
Introduced in version: 
8.5.0
Issue links: 
https://www.drupal.org/node/2926540
https://www.drupal.org/node/1730874
https://www.drupal.org/node/2926483
https://www.drupal.org/node/2926958
Description: 

To be able to group together all entity storage methods providing revision support, RevisionableStorageInterface was added. When defining a new entity type needing revision support be sure to set a storage handler implementing this interface.

Two of its methods are also defined by EntityStorageInterface:

  • RevisionableStorageInterface::loadRevision()
  • RevisionableStorageInterface::deleteRevision()

The corresponding methods on EntityStorageInterface could not be removed but should be considered deprecated. Entity storage classes not implementing ContentEntityStorageInterface and supporting revisions should always implement RevisionableStorageInterface, rather than relying on EntityStorageInterface alone. Those methods will actually be deprecated in the last Drupal 8 minor release and will not be part of Drupal 9.

The new \Drupal\Core\Entity\RevisionableStorageInterface interface contains the following methods:

  • loadRevision()
  • loadMultipleRevisions()
  • deleteRevision()
  • getLatestRevisionId()

Note that additional methods might be added to this interface before Drupal 8.5.0.

The new \Drupal\Core\Entity\TranslatableRevisionableStorageInterface interface contains the following methods:

  • getLatestTranslationAffectingRevisionId()

On top of that, the following methods were added:

  • RevisionableInterface::isLatestRevision()
  • TranslatableRevisionableInterface::isLatestTranslationAffectingRevision
Impacts: 
Module developers

Comments

psf_’s picture

psf_ commented

In the hook_ENTITY_TYPE_predelete PHPStan fail with the message:

Call to deprecated method deleteRevision() of interface
Drupal\Core\Entity\EntityStorageInterface:
in drupal:10.1.0 and is removed from drupal:11.0.0. Use
\Drupal\Core\Entity\RevisionableStorageInterface::deleteRevision instead.

We only need add a var type comment to the $storage variable:

  // Delete checkout country alerts that belong to this account.
  /** @var \Drupal\Core\Entity\RevisionableStorageInterface $storage */
  $storage = \Drupal::entityTypeManager()->getStorage('my_custom_entity');

I added "/** @var" line, and PHPStan go OK.