class FileDealerManager in Media Migration 8

Manages discovery and instantiation of plain file dealer plugins.

View source

class FileDealerManager extends DefaultPluginManager implements FileDealerManagerInterface {

  /**
   * The logger.
   *
   * @var \Psr\Log\LoggerInterface
   */
  protected $logger;

  /**
   * Constructs a new FileDealerManager.
   *
   * @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/media_migration/file', $namespaces, $module_handler, FileDealerPluginInterface::class, FileDealer::class);
    $this
      ->alterInfo('media_migration_file_dealer_info');
    $this
      ->setCacheBackend($cache_backend, 'file_dealer_plugins');
  }

  /**
   * Gets the plugin definitions for the specified scheme and main MIME type.
   *
   * @param string $scheme
   *   The URI scheme.
   * @param string $mime
   *   The main MIME type (the mime type's first part, before the slash).
   *
   * @return mixed[]
   *   An array of the matching plugin definitions (empty array if no
   *   definitions were found).
   */
  protected function getDefinitionsByFieldTypeAndScheme(string $scheme, string $mime) {
    $definitions = $this
      ->getDefinitions();
    $strict_list = array_filter($definitions, function ($definition) use ($scheme, $mime) {
      return in_array($scheme, $definition['schemes'], TRUE) && in_array($mime, $definition['mimes'], TRUE);
    });
    if (!empty($strict_list)) {
      return $strict_list;
    }
    $only_mime_list = array_filter($definitions, function ($definition) use ($mime) {
      return empty($definition['schemes']) && in_array($mime, $definition['mimes'], TRUE);
    });
    if (!empty($only_mime_list)) {
      return $only_mime_list;
    }
    $only_scheme_list = array_filter($definitions, function ($definition) use ($scheme) {
      return in_array($scheme, $definition['schemes'], TRUE) && empty($definition['mimes']);
    });
    if (!empty($only_scheme_list)) {
      return $only_scheme_list;
    }
    if (array_key_exists('fallback', $definitions)) {
      return [
        'fallback' => $definitions['fallback'],
      ];
    }
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function createInstanceFromSchemeAndMime(string $scheme, string $mime) {
    $filtered_definitions = $this
      ->getDefinitionsByFieldTypeAndScheme($scheme, $mime);
    if (!empty($filtered_definitions)) {
      try {
        $configuration = [
          'scheme' => $scheme,
          'mime' => $mime,
        ];
        $plugin_id = array_keys($filtered_definitions)[0];
        return $this
          ->createInstance($plugin_id, $configuration);
      } catch (PluginException $e) {
        return NULL;
      }
    }
    return NULL;
  }

}

Members

Name	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
FileDealerManager::$logger	protected	property	The logger.
FileDealerManager::createInstanceFromSchemeAndMime	public	function	Returns a FileDealer plugin instance that matches the scheme and MIME. Overrides FileDealerManagerInterface::createInstanceFromSchemeAndMime
FileDealerManager::getDefinitionsByFieldTypeAndScheme	protected	function	Gets the plugin definitions for the specified scheme and main MIME type.
FileDealerManager::__construct	public	function	Constructs a new FileDealerManager. 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.

You are here

class FileDealerManager in Media Migration 8

Hierarchy

See also

File

Namespace

Members

API Navigation