class SelectionPluginManager

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager
  2. 10 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager
  3. 11.x core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager

Plugin type manager for Entity Reference Selection plugins.

Hierarchy

Expanded class hierarchy of SelectionPluginManager

See also

\Drupal\Core\Entity\Annotation\EntityReferenceSelection

\Drupal\Core\Entity\EntityReferenceSelection\SelectionInterface

Plugin API

1 string reference to 'SelectionPluginManager'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses SelectionPluginManager
plugin.manager.entity_reference_selection in core/core.services.yml
Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager

File

core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php, line 19

Namespace

Drupal\Core\Entity\EntityReferenceSelection
View source
class SelectionPluginManager extends DefaultPluginManager implements SelectionPluginManagerInterface, FallbackPluginManagerInterface {
    
    /**
     * {@inheritdoc}
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
        $this->alterInfo('entity_reference_selection');
        $this->setCacheBackend($cache_backend, 'entity_reference_selection_plugins');
        parent::__construct('Plugin/EntityReferenceSelection', $namespaces, $module_handler, 'Drupal\\Core\\Entity\\EntityReferenceSelection\\SelectionInterface', 'Drupal\\Core\\Entity\\Annotation\\EntityReferenceSelection');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getInstance(array $options) {
        if (!isset($options['target_type'])) {
            throw new \InvalidArgumentException("Missing required 'target_type' property for a EntityReferenceSelection plugin.");
        }
        // Initialize default options.
        $options += [
            'handler' => $this->getPluginId($options['target_type'], 'default'),
        ];
        // A specific selection plugin ID was already specified.
        if (strpos($options['handler'], ':') !== FALSE) {
            $plugin_id = $options['handler'];
        }
        else {
            $plugin_id = $this->getPluginId($options['target_type'], $options['handler']);
        }
        unset($options['handler']);
        return $this->createInstance($plugin_id, $options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getPluginId($target_type, $base_plugin_id) {
        // Get all available selection plugins for this entity type.
        $selection_handler_groups = $this->getSelectionGroups($target_type);
        // Sort the selection plugins by weight and select the best match.
        uasort($selection_handler_groups[$base_plugin_id], [
            'Drupal\\Component\\Utility\\SortArray',
            'sortByWeightElement',
        ]);
        end($selection_handler_groups[$base_plugin_id]);
        $plugin_id = key($selection_handler_groups[$base_plugin_id]);
        return $plugin_id;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSelectionGroups($entity_type_id) {
        $plugins = [];
        $definitions = $this->getDefinitions();
        // Do not display the 'broken' plugin in the UI.
        unset($definitions['broken']);
        foreach ($definitions as $plugin_id => $plugin) {
            if (empty($plugin['entity_types']) || in_array($entity_type_id, $plugin['entity_types'])) {
                $plugins[$plugin['group']][$plugin_id] = $plugin;
            }
        }
        return $plugins;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSelectionHandler(FieldDefinitionInterface $field_definition, EntityInterface $entity = NULL) {
        $options = $field_definition->getSetting('handler_settings') ?: [];
        $options += [
            'target_type' => $field_definition->getFieldStorageDefinition()
                ->getSetting('target_type'),
            'handler' => $field_definition->getSetting('handler'),
            'entity' => $entity,
        ];
        return $this->getInstance($options);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFallbackPluginId($plugin_id, array $configuration = []) {
        return 'broken';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional annotation namespaces.
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(). 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object of root paths that are traversable.
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.
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::findDefinitions protected function Finds plugin definitions. 7
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 13
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 14
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
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 12
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
SelectionPluginManager::getFallbackPluginId public function Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
SelectionPluginManager::getInstance public function Overrides PluginManagerBase::getInstance
SelectionPluginManager::getPluginId public function Gets the plugin ID for a given target entity type and base plugin ID. Overrides SelectionPluginManagerInterface::getPluginId
SelectionPluginManager::getSelectionGroups public function Gets the selection plugins that can reference a specific entity type. Overrides SelectionPluginManagerInterface::getSelectionGroups
SelectionPluginManager::getSelectionHandler public function Gets the selection handler for a given entity_reference field. Overrides SelectionPluginManagerInterface::getSelectionHandler
SelectionPluginManager::__construct public function Creates the discovery object. Overrides DefaultPluginManager::__construct
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.