Problem/Motivation

ContextAwarePluginBase was deprecated in #2273381: Convert ContextAwarePluginBase to traits.

However, only a runtime deprecation was added. The class phpDoc was not updated to include a @deprecated tag. This prevents it from being picked up my PHPStan's deprecation rules or other static analysis tools.

Steps to reproduce

Scan code extending the class using phpstan + phpstan-drupal + phpstan-deprecation-rules (aka drupal-check or upgrade_status). No error about a class extending this base class.

Proposed resolution

Add @deprecated

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

Issue fork drupal-3264862

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

mglaman created an issue. See original summary.

mglaman opened merge request !1823

mglaman’s picture

mglaman
Primary language English
Location WI, USA
commented
Status: Active » Needs review

Added the @deprecated tag to the class.

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Needs review » Needs work

Minor nitpick around consistent wording with other deprecations, otherwise this looks fine.

ankithashetty made their first commit to this issue’s fork.

ankithashetty’s picture

ankithashetty
Location Karnataka, India
commented
Status: Needs work » Needs review
mglaman’s picture

mglaman
Primary language English
Location WI, USA
commented

Thanks for the fixes @ankithashetty! @longwave I resolved the comment on the MR.

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Needs review » Reviewed & tested by the community

Thanks!

  • catch committed 4dcb45e on 9.4.x 
    Issue #3264862 by mglaman, ankithashetty, longwave:...

  • catch committed e80f6b8 on 9.3.x 
    Issue #3264862 by mglaman, ankithashetty, longwave:...
catch’s picture

catch
he/him
Primary language English
commented
Version: 9.4.x-dev » 9.3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed 4dcb45e and pushed to 9.4.x. Also cherry-picked to 9.3.x. Thanks!

Status: Fixed » Closed (fixed)

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