Contrib.social

Deprecate and remove EntityReferenceDependencyManager

Open on Drupal.org →
Created on 28 February 2025, about 2 months ago

Problem/Motivation

The EntityReferenceDependencyManager class was marked as @deprecated in 2017 via #2918606: Move the dependency manager logic to an entity handler to allow per entity type customisation → , but as far as I can tell there isn't a specific plan for removing it.

PHP CodeSniffer complains that the @deprecated comment does not match the standard pattern, which would explicitly declare which version it is deprecated in and which version it is removed from, as well as link to a tracking issue.

FILE: ...custom/entity_reference_integrity/src/EntityReferenceDependencyManager.php
--------------------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 1 LINE
--------------------------------------------------------------------------------
 11 | ERROR | The text '@deprecated Use the entity handler instead.' does not
    |       | match the standard format: @deprecated in %deprecation-version%
    |       | and is removed from %removal-version%. %extra-info%.
    |       | (Drupal.Commenting.Deprecated.IncorrectTextLayout)
 11 | ERROR | Each @deprecated tag must have a @see tag immediately following
    |       | it (Drupal.Commenting.Deprecated.DeprecatedMissingSeeTag)

Also, the interface EntityReferenceDependencyManagerInterface (implemented by both the deprecated EntityReferenceDependencyManager and the replacement EntityReferenceIntegrityEntityHandler) should probably be renamed once EntityReferenceDependencyManager is removed.

Steps to reproduce

Run phpcs.

Proposed resolution

I propose that we deprecate this more officially in the next 1.x release (1.3), and remove it in 2.x.

Remaining tasks

  • Investigate and refactor any remaining code that uses EntityReferenceDependencyManager internally.
  • Update the @deprecated comment to include deprecation/removal versions and a link to this issue.
  • Remove EntityReferenceDependencyManager in the 2.x branch.
  • Rename EntityReferenceDependencyManagerInterface to EntityReferenceIntegrityEntityHandlerInterface in the 2.x branch.
  • Create a change record to document the new approach.

User interface changes

None.

API changes

Use EntityReferenceIntegrityEntityHandler entity handler instead of the EntityReferenceDependencyManager service.

Data model changes

None.

📌 Task
Status

Active

Version

1.0

Component

Code

Created by

🇺🇸United States m.stenta

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024