class FeaturesAssignmentPackages in Features 8.4

Class for assigning existing modules to packages.

Plugin annotation

@Plugin(
  id = "packages",
  weight = -20,
  name = @Translation("Packages"),
  description = @Translation("Detect and add existing package modules."),
)

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\FeaturesAssignmentPackages

File

src/Plugin/FeaturesAssignment/FeaturesAssignmentPackages.php, line 17

Namespace

Drupal\features\Plugin\FeaturesAssignment

class FeaturesAssignmentPackages extends FeaturesAssignmentMethodBase {

  /**
   * {@inheritdoc}
   */
  public function assignPackages($force = FALSE) {
    $bundle = $this->assigner
      ->getBundle();
    $existing = $this->featuresManager
      ->getFeaturesModules();
    foreach ($existing as $extension) {
      $package = $this->featuresManager
        ->initPackageFromExtension($extension);
      $short_name = $package
        ->getMachineName();

      // Copy over package excluded settings, if any.
      if ($package
        ->getExcluded()) {
        $config_collection = $this->featuresManager
          ->getConfigCollection();
        foreach ($package
          ->getExcluded() as $config_name) {
          if (isset($config_collection[$config_name])) {
            $package_excluded = $config_collection[$config_name]
              ->getPackageExcluded();
            $package_excluded[] = $short_name;
            $config_collection[$config_name]
              ->setPackageExcluded($package_excluded);
          }
        }
        $this->featuresManager
          ->setConfigCollection($config_collection);
      }

      // Assign required components, if any.
      if ($package
        ->getRequired() !== FALSE) {
        $config = $package
          ->getRequired();
        if (empty($config) || !is_array($config)) {

          // If required is "true" or empty, add all config as required.
          $config = $this->featuresManager
            ->listExtensionConfig($extension);
        }
        $this->featuresManager
          ->assignConfigPackage($short_name, $config);
      }
    }
  }

}

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
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.
FeaturesAssignmentPackages::assignPackages	public	function	Performs package assignment. Overrides FeaturesAssignmentMethodInterface::assignPackages
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.