Problem/Motivation

Currently the ConfigurationItem class includes these properties:

  /**
   * Whether the configuration is provided by an extension.
   *
   * @var bool
   */
  protected $extensionProvided = FALSE;

  /**
   * The providing feature.
   *
   * @var string
   */
  protected $providingFeature;

However:

  • We set providingFeature for all extensions, not just features.
  • In core, provider is used for a parallel case, EntityType::provider().
  • extensionProvided is not strictly about whether the item is provided by an extension, but rather whether it has been explicitly excluded from packaging.

Proposed resolution

  • Rename ConfigurationItem::providingFeature to ConfigurationItem::provider, and rename the corresponding getter and setter. Make appropriate changes to code documentation.
  • Rename ConfigurationItem::extensionProvided to ConfigurationItem::excluded and rename the corresponding getter and setter.

Remaining tasks

User interface changes

API changes

Data model changes

Comments

nedjo created an issue. See original summary.

mpotter’s picture

The tricky part of renaming ConfigurationItem::extensionProvided to ConfigurationItem::excluded is that "excluded" property already exists and is used when manually unchecking a config item in the edit form to "exclude" it. This isn't the same as the config excluded by the Exclude plugin.

mpotter’s picture

I'm going to rename ConfigurationItem::extensionProvided to ConfigurationItem::providerExcluded

This should help with the distinction that the config's "provider" was excluded by the Exclude plugin vs the specific config item being "excluded" in the UI.

mpotter’s picture

Status: Active » Needs review
StatusFileSize
new9.02 KB

Here is a patch. Uses a global search so think this is good.

  • mpotter committed fc78c6b on 8.x-3.x
    Issue #2655286 by mpotter: Rename extensionProvided and providingFeature...
mpotter’s picture

Status: Needs review » Fixed

Committed this so I can improve some of the code in the AssignConfig a bit more. fc78c6b

Status: Fixed » Closed (fixed)

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