Deprecate Drupal\Component\Plugin\PluginBase::isConfigurable()

Open on Drupal.org →

Created on 6 July 2024, 6 months ago

Updated 31 July 2024, 5 months ago

Problem/Motivation

In #2946122: Deprecate ConfigurablePluginInterface and replace with an interface that doesn't extend DependentPluginInterface → We added an isConfigurable() method to the PluginBase class as a helper while we were converting things from ConfigurablePluginInterface to ConfigurableInterface, along with a static PluginHelper class to do the same thing. Since ConfigurablePluginInterface is long dead now, all this method does is an instanceOf check against ConfigurableInterface.

The method on the base class is not part of any interface, meaning if core actually used this to check if a plugin was configurable, it would break tests trying to use mocks or prophecies based on plugin interfaces (which is why the static helper was introduced there as well). Fortunately core does not use this.

Looking back at 2946122, I'm not quite sure why we even included it. I'm wondering if it should have been removed when we decided to go with the static helper, and doing so was just missed (by me... :-( ). We deprecated the static helper in 10.1 ( 📌 Deprecate PluginHelper::isConfigurable() Fixed ) and removed it from Drupal 11. We should deprecate this method and remove it from D12 in favor of having any calling code just do an `instanceof ConfigurableInterface` check

Steps to reproduce

Proposed resolution

Deprecate PluginBase->isConfigurable in D11.1 and remove from D12.0

Remaining tasks

Review and commit

User interface changes

API changes

PluginBase->isConfigurable() is deprecated

Data model changes

Release notes snippet

\Drupal\Component\Plugin\PluginBase->isConfigurable() is deprecated. Use instanceof to check if a plugin implements ConfigurableInterface instead.

📌 Task

Status

Fixed

Version

11.0 🔥

Component

Last updated 9 days ago

Maintained by
🇺🇸United States @eclipsegc
🇺🇸United States @effulgentsia
🇺🇸United States @tim.plunkett

Created by

🇺🇸United States mikelutz Michigan, USA

Live updates comments and jobs are added and updated live.

Needs Review Queue Initiative
Used to track the progress of issues reviewed by the Drupal Needs Review Queue Initiative.

Sign in to follow issues

Merge Requests

!8684Deprecate Drupal\Component\Plugin\PluginBase::isConfigurable()
Closed
🇺🇸United States mikelutz
updated 6 months ago

Comments & Activities

Issue created by @mikelutz
Merge request !86843459533: Deprecate PluginBase::isConfigurable() → (Closed) created by mikelutz
Pipeline finished with Success
6 months ago
Total: 2293s
#217405
Status changed to Needs review 6 months ago2:46pm 6 July 2024
Comment 6 months ago →
🇺🇸United States mikelutz Michigan, USA
Comment 6 months ago →
🇺🇸United States mikelutz Michigan, USA
Status changed to RTBC 6 months ago1:02am 8 July 2024
Comment 6 months ago →
🇺🇸United States smustgrave
Deprecation versions seem correct. Has simple test case for it. CR is there. Believe this is good

Comment 6 months ago →

catch → committed 996c75cb on 11.x

Issue #3459533 by mikelutz: Deprecate Drupal\Component\Plugin\PluginBase...

Comment 6 months ago →
🇬🇧United Kingdom catch
Went ahead and committed this without the test coverage:

- we generally don't add deprecation testing unless there's an actual bc layer involved, just triggering the deprecation is enough.

- getMockForAbstractClass() is deprecated in phpunit 10 and we only don't need to add it to the baseline because it's being called in a @legacy test. It would mean having to remove or refactor this test before we can update to phpunit 11 - another reason to skip test coverage.

Committed/pushed to 11.x, thanks!
Status changed to Fixed 6 months ago11:56am 17 July 2024
Comment 6 months ago →
System Message
catch → closed merge request !8684
Comment 5 months ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024