You are here

Home » API reference » CMS Content Sync 2.0.x » EntityHandlerPluginManager.php

class EntityHandlerPluginManager in CMS Content Sync 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Type/EntityHandlerPluginManager.php \Drupal\cms_content_sync\Plugin\Type\EntityHandlerPluginManager
  2. 2.1.x src/Plugin/Type/EntityHandlerPluginManager.php \Drupal\cms_content_sync\Plugin\Type\EntityHandlerPluginManager

Manages discovery and instantiation of entity handler plugins.

Hierarchy

Expanded class hierarchy of EntityHandlerPluginManager

See also

\Drupal\cms_content_sync\Annotation\EntityHandler

\Drupal\cms_content_sync\Plugin\EntityHandlerBase

\Drupal\cms_content_sync\Plugin\EntityHandlerInterface

Plugin API

16 files declare their use of EntityHandlerPluginManager
cms_content_sync.module in ./cms_content_sync.module
Module file for cms_content_sync.
Compatibility.php in src/Controller/Compatibility.php
Embed.php in src/Controller/Embed.php
EntityHandlerBase.php in src/Plugin/EntityHandlerBase.php
EntityReferenceHandlerBase.php in src/Plugin/EntityReferenceHandlerBase.php

... See full list

File

src/Plugin/Type/EntityHandlerPluginManager.php, line 19

Namespace

Drupal\cms_content_sync\Plugin\Type
View source 
class EntityHandlerPluginManager extends DefaultPluginManager {

  /**
   * Constructor.
   *
   * Constructs a new
   * \Drupal\cms_content_sync\Plugin\Type\EntityHandlerPluginManager 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
   *                                                                      Cache backend instance to use
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *                                                                      The module handler to invoke the alter hook with
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/cms_content_sync/entity_handler', $namespaces, $module_handler, 'Drupal\\cms_content_sync\\Plugin\\EntityHandlerInterface', 'Drupal\\cms_content_sync\\Annotation\\EntityHandler');
    $this
      ->setCacheBackend($cache_backend, 'cms_content_sync_entity_handler_plugins');
    $this
      ->alterInfo('cms_content_sync_entity_handler');
  }

  /**
   * @param EntityTypeInterface|string $type
   *
   * @return bool
   */
  public static function isEntityTypeFieldable($type) {
    if (is_string($type)) {

      /**
       * @var \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
       */
      $entityTypeManager = \Drupal::service('entity_type.manager');
      $type = $entityTypeManager
        ->getDefinition($type, false);
    }
    return $type ? $type
      ->entityClassImplements('Drupal\\Core\\Entity\\FieldableEntityInterface') : false;
  }

  /**
   * @param EntityTypeInterface|string $type
   *
   * @return bool
   */
  public static function isEntityTypeConfiguration($type) {
    if (is_string($type)) {

      /**
       * @var \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
       */
      $entityTypeManager = \Drupal::service('entity_type.manager');
      $type = $entityTypeManager
        ->getDefinition($type);
    }
    return $type
      ->entityClassImplements('Drupal\\Core\\Config\\Entity\\ConfigEntityInterface');
  }

  /**
   * @param mixed $type_key
   * @param mixed $entity_bundle_name
   */
  public static function getEntityTypeInfo($type_key, $entity_bundle_name) {
    static $cache = [];
    if (!empty($cache[$type_key][$entity_bundle_name])) {
      return $cache[$type_key][$entity_bundle_name];
    }
    $info = [
      'entity_type' => $type_key,
      'bundle' => $entity_bundle_name,
      'required_field_not_supported' => false,
      'optional_field_not_supported' => false,
    ];

    /**
     * @var \Drupal\Core\Entity\EntityTypeManager $entityTypeManager
     */
    $entityTypeManager = \Drupal::service('entity_type.manager');
    $type = $entityTypeManager
      ->getDefinition($type_key);

    /**
     * @var EntityHandlerPluginManager $entityPluginManager
     */
    $entityPluginManager = \Drupal::service('plugin.manager.cms_content_sync_entity_handler');
    $entity_handlers = $entityPluginManager
      ->getHandlerOptions($type_key, $entity_bundle_name, true);
    if (empty($entity_handlers)) {
      $info['no_entity_type_handler'] = true;
      if ('user' == $type_key) {
        $info['security_concerns'] = true;
      }
      elseif ($type instanceof ConfigEntityType) {
        $info['is_config_entity'] = true;
      }
    }
    else {
      $info['no_entity_type_handler'] = false;
      if ('block_content' == $type_key) {
        $info['hint'] = 'except for config like block placement';
      }
      elseif ('paragraph' == $type_key) {
        $info['hint'] = 'Paragraphs version >= 8.x-1.3';
      }
      elseif ('field_collection_item' == $type_key) {
        $info['hint'] = 'Paragraphs version 8.x-1.0-alpha1';
      }
      $entity_handlers = array_keys($entity_handlers);
      $handler = $entityPluginManager
        ->createInstance(reset($entity_handlers), [
        'entity_type_name' => $type_key,
        'bundle_name' => $entity_bundle_name,
        'settings' => [],
        'sync' => null,
      ]);
      $reserved = [];
      $pools = Pool::getAll();
      if (count($pools)) {
        $reserved = reset($pools)
          ->getClient()
          ->getReservedPropertyNames();
      }
      $forbidden_fields = array_merge($handler
        ->getForbiddenFields(), $reserved);
      $info['unsupported_required_fields'] = [];
      $info['unsupported_optional_fields'] = [];

      /**
       * @var FieldHandlerPluginManager $fieldPluginManager
       */
      $fieldPluginManager = \Drupal::service('plugin.manager.cms_content_sync_field_handler');

      /**
       * @var \Drupal\Core\Entity\EntityFieldManager $entityFieldManager
       */
      $entityFieldManager = \Drupal::service('entity_field.manager');
      if (!self::isEntityTypeFieldable($type)) {
        $info['fieldable'] = false;
      }
      else {
        $info['fieldable'] = true;

        /**
         * @var \Drupal\Core\Field\FieldDefinitionInterface[] $fields
         */
        $fields = $entityFieldManager
          ->getFieldDefinitions($type_key, $entity_bundle_name);
        foreach ($fields as $key => $field) {
          if (in_array($key, $forbidden_fields)) {
            continue;
          }
          $field_handlers = $fieldPluginManager
            ->getHandlerOptions($type_key, $entity_bundle_name, $key, $field, true);
          if (!empty($field_handlers)) {
            continue;
          }
          $name = $key . ' (' . $field
            ->getType() . ')';
          if ($field
            ->isRequired()) {
            $info['unsupported_required_fields'][] = $name;
          }
          else {
            $info['unsupported_optional_fields'][] = $name;
          }
        }
        $info['required_field_not_supported'] = count($info['unsupported_required_fields']) > 0;
        $info['optional_field_not_supported'] = count($info['unsupported_optional_fields']) > 0;
      }
    }
    $info['is_supported'] = !$info['no_entity_type_handler'] && !$info['required_field_not_supported'];
    return $cache[$type_key][$entity_bundle_name] = $info;
  }

  /**
   * Check whether or not the given entity type is supported.
   *
   * @param $type_key
   * @param $entity_bundle_name
   *
   * @return mixed
   */
  public static function isSupported($type_key, $entity_bundle_name) {
    return self::getEntityTypeInfo($type_key, $entity_bundle_name)['is_supported'];
  }

  /**
   * {@inheritdoc}
   *
   * @deprecated in Drupal 8.2.0.
   *   Use Drupal\rest\Plugin\Type\ResourcePluginManager::createInstance()
   *   instead.
   * @see https://www.drupal.org/node/2874934
   */
  public function getInstance(array $options) {
    if (isset($options['id'])) {
      return $this
        ->createInstance($options['id']);
    }
    return null;
  }

  /**
   * @param string $entity_type
   *                            The entity type of the processed entity
   * @param string $bundle
   *                            The bundle of the processed entity
   * @param bool   $labels_only
   *                            Whether to return labels instead of the whole definition
   *
   * @return array
   *               An associative array $id=>$label|$handlerDefinition to display options
   */
  public function getHandlerOptions($entity_type, $bundle, $labels_only = false) {
    $options = [];
    foreach ($this
      ->getDefinitions() as $id => $definition) {
      if (!$definition['class']::supports($entity_type, $bundle)) {
        continue;
      }
      $options[$id] = $labels_only ? $definition['label']
        ->render() : $definition;
    }
    return $options;
  }

  /**
   * Return a list of all entity types and which are supported.
   *
   * @return array
   */
  public static function getEntityTypes() {
    $supported_entity_types = [];
    $entity_types = \Drupal::service('entity_type.bundle.info')
      ->getAllBundleInfo();
    ksort($entity_types);
    foreach ($entity_types as $type_key => $entity_type) {
      if ('cms_content_sync' == substr($type_key, 0, 16)) {
        continue;
      }
      ksort($entity_type);
      foreach ($entity_type as $entity_bundle_name => $entity_bundle) {
        $supported_entity_types[] = EntityHandlerPluginManager::getEntityTypeInfo($type_key, $entity_bundle_name);
      }
    }
    return $supported_entity_types;
  }

  /**
   * {@inheritdoc}
   */
  protected function findDefinitions() {
    $definitions = parent::findDefinitions();
    uasort($definitions, function ($a, $b) {
      return $a['weight'] <=> $b['weight'];
    });
    return $definitions;
  }

}

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 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
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::processDefinition public function Performs extra processing on plugin definitions. 13
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
EntityHandlerPluginManager::findDefinitions protected function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
EntityHandlerPluginManager::getEntityTypeInfo public static function
EntityHandlerPluginManager::getEntityTypes public static function Return a list of all entity types and which are supported.
EntityHandlerPluginManager::getHandlerOptions public function
EntityHandlerPluginManager::getInstance Deprecated public function Overrides PluginManagerBase::getInstance
EntityHandlerPluginManager::isEntityTypeConfiguration public static function
EntityHandlerPluginManager::isEntityTypeFieldable public static function
EntityHandlerPluginManager::isSupported public static function Check whether or not the given entity type is supported.
EntityHandlerPluginManager::__construct public function Constructor. 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::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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.