You are here

class FeaturesAssignmentForwardDependency in Features 8.3

Same name and namespace in other branches
  1. 8.4 src/Plugin/FeaturesAssignment/FeaturesAssignmentForwardDependency.php \Drupal\features\Plugin\FeaturesAssignment\FeaturesAssignmentForwardDependency

Class for assigning configuration to packages based on forward dependencies.

Plugin annotation


@Plugin(
  id = "forward_dependency",
  weight = 20,
  name = @Translation("Forward dependency"),
  description = @Translation("Add to packages configuration on which items in the package depend."),
)

Hierarchy

Expanded class hierarchy of FeaturesAssignmentForwardDependency

File

src/Plugin/FeaturesAssignment/FeaturesAssignmentForwardDependency.php, line 18

Namespace

Drupal\features\Plugin\FeaturesAssignment
View source
class FeaturesAssignmentForwardDependency extends FeaturesAssignmentMethodBase {

  /**
   * {@inheritdoc}
   */
  public function assignPackages($force = FALSE) {
    $config_collection = $this->featuresManager
      ->getConfigCollection();
    $ordered = $this
      ->dependencyOrder($config_collection);
    foreach ($ordered as $name) {
      $item = $config_collection[$name];
      if ($item
        ->getPackage()) {

        // Already has a package, not our business.
        continue;
      }

      // Find packages of dependent items.
      $dependent_packages = [];
      foreach ($item
        ->getDependents() as $dependent) {
        if (isset($config_collection[$dependent])) {
          if ($package = $config_collection[$dependent]
            ->getPackage()) {
            $dependent_packages[$package] = $package;
          }
        }
      }

      // If zero or multiple packages, we don't know what to do.
      if (count($dependent_packages) == 1) {
        $package = key($dependent_packages);
        $this->featuresManager
          ->assignConfigPackage($package, [
          $name,
        ]);
      }
    }
  }

  /**
   * Get config items such that each item comes before anything it depends on.
   *
   * @param \Drupal\features\ConfigurationItem[] $config_collection
   *   A collection of configuration items.
   *
   * @return string[]
   *   The names of configuration items, in dependency order.
   */
  protected function dependencyOrder(array $config_collection) {

    // Populate a graph.
    $graph = [];
    foreach ($config_collection as $config) {
      $graph[$config
        ->getName()] = [];
      foreach ($config
        ->getDependents() as $dependent) {
        $graph[$config
          ->getName()]['edges'][$dependent] = 1;
      }
    }
    $graph_object = new Graph($graph);
    $graph = $graph_object
      ->searchAndSort();

    // Order by inverse weight.
    $weights = array_column($graph, 'weight');
    array_multisort($weights, SORT_DESC, $graph);
    return array_keys($graph);
  }

}

Members

Namesort descending 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
FeaturesAssignmentForwardDependency::assignPackages public function Performs package assignment. Overrides FeaturesAssignmentMethodInterface::assignPackages
FeaturesAssignmentForwardDependency::dependencyOrder protected function Get config items such that each item comes before anything it depends on.
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.