class SelectionPluginManager in Zircon Profile 8

Same name and namespace in other branches

8.0 core/lib/Drupal/Core/Entity/EntityReferenceSelection/SelectionPluginManager.php \Drupal\Core\Entity\EntityReferenceSelection\SelectionPluginManager

Plugin type manager for Entity Reference Selection plugins.

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 += array(
      'handler' => $this
        ->getPluginId($options['target_type'], 'default'),
      'handler_settings' => array(),
    );

    // 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']);
    }
    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], array(
      '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 = array();
    $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 = array(
      'target_type' => $field_definition
        ->getFieldStorageDefinition()
        ->getSetting('target_type'),
      'handler' => $field_definition
        ->getSetting('handler'),
      'handler_settings' => $field_definition
        ->getSetting('handler_settings') ?: array(),
      'entity' => $entity,
    );
    return $this
      ->getInstance($options);
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
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.	5
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.
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.
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	Initializes the alter hook.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	4
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	2
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
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	7
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	10
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	1
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	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	11
SelectionPluginManager::getFallbackPluginId	public	function	Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
SelectionPluginManager::getInstance	public	function	Gets a preconfigured instance of a plugin. 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.

You are here

class SelectionPluginManager in Zircon Profile 8

Hierarchy

See also

File

Namespace

Members

API Navigation