You are here

Home » API reference » Entity Export CSV 8 » FieldTypeExportManager.php

class FieldTypeExportManager in Entity Export CSV 8

Provides the Field type export plugin manager.

Hierarchy

Expanded class hierarchy of FieldTypeExportManager

1 string reference to 'FieldTypeExportManager'
entity_export_csv.services.yml in ./entity_export_csv.services.yml
entity_export_csv.services.yml
1 service uses FieldTypeExportManager
plugin.manager.field_type_export in ./entity_export_csv.services.yml
Drupal\entity_export_csv\Plugin\FieldTypeExportManager

File

src/Plugin/FieldTypeExportManager.php, line 12

Namespace

Drupal\entity_export_csv\Plugin
View source 
class FieldTypeExportManager extends DefaultPluginManager implements FieldTypeExportManagerInterface {

  /**
   * Constructs a new FieldTypeExportManager 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/FieldTypeExport', $namespaces, $module_handler, 'Drupal\\entity_export_csv\\Plugin\\FieldTypeExportInterface', 'Drupal\\entity_export_csv\\Annotation\\FieldTypeExport');
    $this
      ->alterInfo('entity_export_csv_field_type_export_info');
    $this
      ->setCacheBackend($cache_backend, 'entity_export_csv_field_type_export_plugins');
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions() {
    $options = [];
    $definitions = $this
      ->getDefinitions();
    $this
      ->sortDefinitions($definitions);
    foreach ($definitions as $plugin_id => $definition) {
      $options[$plugin_id] = $definition['label'];
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldTypeOptions($field_type, $entity_type = NULL, $bundle = NULL, $field_name = NULL) {
    $options = [];
    $definitions = $this
      ->getDefinitions();
    $this
      ->sortDefinitions($definitions);
    foreach ($definitions as $plugin_id => $definition) {
      if (!isset($definition['field_type'])) {
        continue;
      }
      if (in_array($field_type, $definition['field_type']) || empty($definition['field_type'])) {
        if ($entity_type) {
          if (!empty($definition['entity_type']) && !in_array($entity_type, $definition['entity_type'])) {
            continue;
          }
        }
        if ($bundle) {
          if (!empty($definition['bundle']) && !in_array($bundle, $definition['bundle'])) {
            continue;
          }
        }
        if ($field_name) {
          if (!empty($definition['field_name']) && !in_array($field_name, $definition['field_name'])) {
            continue;
          }
        }
        if (isset($definition['exclusive']) && $definition['exclusive'] === TRUE) {
          return [
            $plugin_id => $definition['label'],
          ];
        }
        $options[$plugin_id] = $definition['label'];
      }
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function removeExcludeDefinitions(array $definitions) {
    $definitions = isset($definitions) ? $definitions : $this
      ->getDefinitions();

    // Exclude 'broken' fallback plugin.
    unset($definitions['broken']);
    return $definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackPluginId($plugin_id, array $configuration = []) {
    return 'broken';
  }

  /**
   * Sort definitions by weigth descending.
   *
   * @param array $definitions
   *   The definitions.
   */
  protected function sortDefinitions(array &$definitions) {
    uasort($definitions, function ($a, $b) {
      return $a['weight'] - $b['weight'];
    });
  }

}

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::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
FieldTypeExportManager::getFallbackPluginId public function
FieldTypeExportManager::getFieldTypeOptions public function Get definition options for a given field type. Overrides FieldTypeExportManagerInterface::getFieldTypeOptions
FieldTypeExportManager::getOptions public function Get definition options. Overrides FieldTypeExportManagerInterface::getOptions
FieldTypeExportManager::removeExcludeDefinitions public function
FieldTypeExportManager::sortDefinitions protected function Sort definitions by weigth descending.
FieldTypeExportManager::__construct public function Constructs a new FieldTypeExportManager 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.