abstract class FeaturesAssignmentMethodBase in Features 8.4

Base class for package assignment methods.

Hierarchy

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

12 files declare their use of FeaturesAssignmentMethodBase

FeaturesAssignmentAlter.php in src/Plugin/FeaturesAssignment/FeaturesAssignmentAlter.php

FeaturesAssignmentBaseType.php in src/Plugin/FeaturesAssignment/FeaturesAssignmentBaseType.php

FeaturesAssignmentCoreType.php in src/Plugin/FeaturesAssignment/FeaturesAssignmentCoreType.php

FeaturesAssignmentDependency.php in src/Plugin/FeaturesAssignment/FeaturesAssignmentDependency.php

FeaturesAssignmentExclude.php in src/Plugin/FeaturesAssignment/FeaturesAssignmentExclude.php

... See full list

File

src/FeaturesAssignmentMethodBase.php, line 12

Namespace

Drupal\features

abstract class FeaturesAssignmentMethodBase extends PluginBase implements FeaturesAssignmentMethodInterface {

  /**
   * The features manager.
   *
   * @var \Drupal\features\FeaturesManagerInterface
   */
  protected $featuresManager;

  /**
   * The features assigner.
   *
   * @var \Drupal\features\FeaturesAssignerInterface
   */
  protected $assigner;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  public function setfeaturesManager(FeaturesManagerInterface $features_manager) {
    $this->featuresManager = $features_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function setAssigner(FeaturesAssignerInterface $assigner) {
    $this->assigner = $assigner;
  }

  /**
   * {@inheritdoc}
   */
  public function setEntityTypeManager(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfigFactory(ConfigFactoryInterface $config_factory) {
    $this->configFactory = $config_factory;
  }

  /**
   * Assigns configuration of the types specified in a setting to a package.
   *
   * @param string $machine_name
   *   Machine name of the package.
   * @param bool $force
   *   (optional) If TRUE, assign config regardless of restrictions such as it
   *   being already assigned to a package.
   */
  protected function assignPackageByConfigTypes($machine_name, $force = FALSE) {
    $current_bundle = $this->assigner
      ->getBundle();
    $settings = $current_bundle
      ->getAssignmentSettings($this
      ->getPluginId());
    $types = $settings['types']['config'];
    $config_collection = $this->featuresManager
      ->getConfigCollection();
    foreach ($config_collection as $item_name => $item) {

      // Don't assign configuration that's provided by an extension.
      if (in_array($item
        ->getType(), $types) && !$item
        ->isProviderExcluded()) {
        try {
          $this->featuresManager
            ->assignConfigPackage($machine_name, [
            $item_name,
          ]);
        } catch (\Exception $exception) {
          \Drupal::logger('features')
            ->error($exception
            ->getMessage());
        }
      }
    }
  }

  /**
   * Assigns a given subdirectory to configuration of specified types.
   *
   * @param string $subdirectory
   *   The subdirectory that designated configuration should be exported to.
   */
  protected function assignSubdirectoryByConfigTypes($subdirectory) {
    $current_bundle = $this->assigner
      ->getBundle();
    $settings = $current_bundle
      ->getAssignmentSettings($this
      ->getPluginId());
    $types = $settings['types']['config'];
    if (!empty($types)) {
      $config_collection = $this->featuresManager
        ->getConfigCollection();
      foreach ($config_collection as &$item) {
        if (in_array($item
          ->getType(), $types)) {
          $item
            ->setSubdirectory($subdirectory);
        }
      }

      // Clean up the $item pass by reference.
      unset($item);
      $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
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::assignPackages	public	function	Performs package assignment.	12
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.