class FeaturesAssignmentAlter in Features 8.4

Class for excluding configuration from packages.

Plugin annotation

@Plugin(
  id = "alter",
  weight = 0,
  name = @Translation("Alter"),
  description = @Translation("Alter configuration items before they are exported. Altering includes options such as removing permissions from roles."),
  config_route_name = "features.assignment_alter",
  default_settings = {
    "core" = TRUE,
    "uuid" = TRUE,
    "user_permissions" = TRUE,
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\features\FeaturesAssignmentMethodBase implements FeaturesAssignmentMethodInterface
      • class \Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentAlter

File

src/Plugin/FeaturesAssignment/FeaturesAssignmentAlter.php, line 24

Namespace

Drupal\features\Plugin\FeaturesAssignment

class FeaturesAssignmentAlter extends FeaturesAssignmentMethodBase {

  /**
   * {@inheritdoc}
   */
  public function assignPackages($force = FALSE) {
    $current_bundle = $this->assigner
      ->getBundle();
    $settings = $current_bundle
      ->getAssignmentSettings($this
      ->getPluginId());

    // Alter configuration items.
    if ($settings['core'] || $settings['uuid'] || $settings['user_permissions']) {
      $config_collection = $this->featuresManager
        ->getConfigCollection();
      foreach ($config_collection as &$config) {
        $data = $config
          ->getData();
        if ($settings['core']) {
          unset($data['_core']);
        }

        // Unset UUID for configuration entities.
        if ($settings['uuid'] && $config
          ->getType() !== FeaturesManagerInterface::SYSTEM_SIMPLE_CONFIG) {
          unset($data['uuid']);
        }

        // Unset permissions for user roles. Doing so facilitates packaging
        // roles that may have permissions that relate to multiple packages.
        if ($settings['user_permissions'] && $config
          ->getType() == 'user_role') {

          // Unset and not empty permissions data to prevent loss of configured
          // role permissions in the event of a feature revert.
          unset($data['permissions']);
        }
        $config
          ->setData($data);
      }

      // Clean up the $config pass by reference.
      unset($config);

      // Register the updated data.
      $this->featuresManager
        ->setConfigCollection($config_collection);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FeaturesAssignmentAlter::assignPackages	public	function	Performs package assignment. Overrides FeaturesAssignmentMethodInterface::assignPackages
FeaturesAssignmentMethodBase::$assigner	protected	property	The features assigner.
FeaturesAssignmentMethodBase::$configFactory	protected	property	The configuration factory.
FeaturesAssignmentMethodBase::$entityTypeManager	protected	property	The entity type manager.
FeaturesAssignmentMethodBase::$featuresManager	protected	property	The features manager.
FeaturesAssignmentMethodBase::assignPackageByConfigTypes	protected	function	Assigns configuration of the types specified in a setting to a package.
FeaturesAssignmentMethodBase::assignSubdirectoryByConfigTypes	protected	function	Assigns a given subdirectory to configuration of specified types.
FeaturesAssignmentMethodBase::setAssigner	public	function	Injects the features assigner. Overrides FeaturesAssignmentMethodInterface::setAssigner
FeaturesAssignmentMethodBase::setConfigFactory	public	function	Injects the configuration factory. Overrides FeaturesAssignmentMethodInterface::setConfigFactory
FeaturesAssignmentMethodBase::setEntityTypeManager	public	function	Injects the entity manager. Overrides FeaturesAssignmentMethodInterface::setEntityTypeManager
FeaturesAssignmentMethodBase::setfeaturesManager	public	function
FeaturesAssignmentMethodInterface::setFeaturesManager	public	function	Injects the features manager.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.