You are here

Home » API reference » Commerce Core 8.2 » EntityTraitManager.php

class EntityTraitManager in Commerce Core 8.2

Manages discovery and instantiation of entity trait plugins.

Hierarchy

Expanded class hierarchy of EntityTraitManager

See also

\Drupal\commerce\Annotation\CommerceEntityTrait

Plugin API

1 string reference to 'EntityTraitManager'
commerce.services.yml in ./commerce.services.yml
commerce.services.yml
1 service uses EntityTraitManager
plugin.manager.commerce_entity_trait in ./commerce.services.yml
Drupal\commerce\EntityTraitManager

File

src/EntityTraitManager.php, line 17

Namespace

Drupal\commerce
View source 
class EntityTraitManager extends DefaultPluginManager implements EntityTraitManagerInterface {

  /**
   * The configurable field manager.
   *
   * @var \Drupal\commerce\ConfigurableFieldManagerInterface
   */
  protected $configurableFieldManager;

  /**
   * Constructs a new EntityTraitManager object.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\commerce\ConfigurableFieldManagerInterface $configurable_field_manager
   *   The configurable field manager.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigurableFieldManagerInterface $configurable_field_manager) {
    parent::__construct('Plugin/Commerce/EntityTrait', $namespaces, $module_handler, 'Drupal\\commerce\\Plugin\\Commerce\\EntityTrait\\EntityTraitInterface', 'Drupal\\commerce\\Annotation\\CommerceEntityTrait');
    $this
      ->alterInfo('commerce_entity_trait_info');
    $this
      ->setCacheBackend($cache_backend, 'commerce_entity_trait_plugins');
    $this->configurableFieldManager = $configurable_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function processDefinition(&$definition, $plugin_id) {
    parent::processDefinition($definition, $plugin_id);
    foreach ([
      'id',
      'label',
    ] as $required_property) {
      if (empty($definition[$required_property])) {
        throw new PluginException(sprintf('The entity trait %s must define the %s property.', $plugin_id, $required_property));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitionsByEntityType($entity_type_id) {
    $definitions = $this
      ->getDefinitions();
    $definitions = array_filter($definitions, function ($definition) use ($entity_type_id) {
      return empty($definition['entity_types']) || in_array($entity_type_id, $definition['entity_types']);
    });
    return $definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function detectConflicts(EntityTraitInterface $trait, array $installed_traits) {
    $field_names = array_keys($trait
      ->buildFieldDefinitions());
    if (!$field_names) {
      return [];
    }
    $conflicting_traits = [];
    foreach ($installed_traits as $installed_trait) {
      $installed_field_names = array_keys($installed_trait
        ->buildFieldDefinitions());
      if (array_intersect($field_names, $installed_field_names)) {
        $conflicting_traits[] = $installed_trait;
      }
    }
    return $conflicting_traits;
  }

  /**
   * {@inheritdoc}
   */
  public function installTrait(EntityTraitInterface $trait, $entity_type_id, $bundle) {

    // The fields provided by an entity trait are maintained as locked
    // configurable fields, for simplicity.
    foreach ($trait
      ->buildFieldDefinitions() as $field_name => $field_definition) {
      $field_definition
        ->setTargetEntityTypeId($entity_type_id);
      $field_definition
        ->setTargetBundle($bundle);
      $field_definition
        ->setName($field_name);
      $this->configurableFieldManager
        ->createField($field_definition);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function canUninstallTrait(EntityTraitInterface $trait, $entity_type_id, $bundle) {
    foreach ($trait
      ->buildFieldDefinitions() as $field_name => $field_definition) {
      $field_definition
        ->setTargetEntityTypeId($entity_type_id);
      $field_definition
        ->setTargetBundle($bundle);
      $field_definition
        ->setName($field_name);
      if ($this->configurableFieldManager
        ->hasData($field_definition)) {
        return FALSE;
      }
    }
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function uninstallTrait(EntityTraitInterface $trait, $entity_type_id, $bundle) {
    foreach ($trait
      ->buildFieldDefinitions() as $field_name => $field_definition) {
      $field_definition
        ->setTargetEntityTypeId($entity_type_id);
      $field_definition
        ->setTargetBundle($bundle);
      $field_definition
        ->setName($field_name);
      $this->configurableFieldManager
        ->deleteField($field_definition);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
EntityTraitManager::$configurableFieldManager protected property The configurable field manager.
EntityTraitManager::canUninstallTrait public function Checks whether the given trait can be uninstalled. Overrides EntityTraitManagerInterface::canUninstallTrait
EntityTraitManager::detectConflicts public function Detects conflicts between the given trait and the installed traits. Overrides EntityTraitManagerInterface::detectConflicts
EntityTraitManager::getDefinitionsByEntityType public function Gets the definitions filtered by entity type. Overrides EntityTraitManagerInterface::getDefinitionsByEntityType
EntityTraitManager::installTrait public function Installs the given trait for the given entity type and bundle. Overrides EntityTraitManagerInterface::installTrait
EntityTraitManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
EntityTraitManager::uninstallTrait public function Uninstalls the given trait for the given entity type and bundle. Overrides EntityTraitManagerInterface::uninstallTrait
EntityTraitManager::__construct public function Constructs a new EntityTraitManager object. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.