Problem/Motivation

ConfigProviderBase provides two unnecessary methods that wrap Drupal services that should be removed (especially after the dependency injection improvements made in #3457459: GitLabCI: Fix existing PHPCS & PHPStan issues):

  • ConfigProviderBase::drupalGetPath()
  • ConfigProviderBase::drupalGetProfile()

Steps to reproduce

Proposed resolution

  • Deprecate methods ahead of next release/pre-release.
  • Remove methods ahead of a future release.

Remaining tasks

User interface changes

API changes

  • ConfigProviderBase::drupalGetPath() will be deprecated (and later removed).
  • ConfigProviderBase::drupalGetProfile() will be deprecated (and later removed).

Data model changes

Issue fork config_provider-3500568

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

joegraduate created an issue. See original summary.

joegraduate’s picture

joegraduate
Primary language English
Location Arizona, USA
commented
Issue summary: View changes

joegraduate opened merge request !13

joegraduate’s picture

joegraduate
Primary language English
Location Arizona, USA
commented
Status: Active » Postponed
Related issues: +#3457459: GitLabCI: Fix existing PHPCS & PHPStan issues

Waiting on #3457459: GitLabCI: Fix existing PHPCS & PHPStan issues.

joegraduate’s picture

joegraduate
Primary language English
Location Arizona, USA
commented
Status: Postponed » Needs review
joegraduate’s picture

joegraduate
Primary language English
Location Arizona, USA
commented
Assigned: joegraduate » Unassigned
trackleft2’s picture

trackleft2
Primary language English
Location Tucson, AZ 🇺🇸
commented
Status: Needs review » Reviewed & tested by the community

Looks good, as long as we remember to include it in the 3.0.0-alpha2 release.

tadean’s picture

tadean
Primary language English
Location Arizona, USA
commented

Verified that implementers of ConfigProviderBase receive the expected deprecation warnings:

 ------ ----------------------------------------------------------------------------------------------------------------- 
  Line   web/modules/custom/test_provider/src/Plugin/ConfigProvider/TestConfigProvider.php  
 ------ ----------------------------------------------------------------------------------------------------------------- 
  332    Call to deprecated method drupalGetProfile() of class Drupal\config_provider\Plugin\ConfigProviderBase:          
         in config_provider:3.0.0-alpha2 and is removed from config_provider:3.1.0.                                       
           ConfigProviderBase::installProfile should be used instead.                                                     
  333    Call to deprecated method drupalGetPath() of class Drupal\config_provider\Plugin\ConfigProviderBase:             
         in config_provider:3.0.0-alpha2 and is removed from config_provider:3.1.0.                                       
           ConfigProviderBase::extensionPathResolver::getPath() should be used                                            
           instead.                                                                                                       
 ------ -----------------------------------------------------------------------------------------------------------------
joegraduate’s picture

joegraduate
Primary language English
Location Arizona, USA
commented

tadean’s picture

tadean
Primary language English
Location Arizona, USA
commented
Status: Reviewed & tested by the community » Fixed

Thanks @joegraduate !

Status: Fixed » Closed (fixed)

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