You are here

class ViewsHandlerManager in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/views/src/Plugin/ViewsHandlerManager.php \Drupal\views\Plugin\ViewsHandlerManager

Plugin type manager for all views handlers.

Hierarchy

Expanded class hierarchy of ViewsHandlerManager

5 files declare their use of ViewsHandlerManager
EntityReverse.php in core/modules/views/src/Plugin/views/relationship/EntityReverse.php
LatestRevision.php in core/modules/views/src/Plugin/views/filter/LatestRevision.php
LatestTranslationAffectedRevision.php in core/modules/views/src/Plugin/views/filter/LatestTranslationAffectedRevision.php
ViewsHandlerManagerTest.php in core/modules/views/tests/src/Unit/ViewsHandlerManagerTest.php
ViewsQueryAlter.php in core/modules/workspaces/src/ViewsQueryAlter.php
1 string reference to 'ViewsHandlerManager'
views.services.yml in core/modules/views/views.services.yml
core/modules/views/views.services.yml
7 services use ViewsHandlerManager
plugin.manager.views.area in core/modules/views/views.services.yml
Drupal\views\Plugin\ViewsHandlerManager
plugin.manager.views.argument in core/modules/views/views.services.yml
Drupal\views\Plugin\ViewsHandlerManager
plugin.manager.views.field in core/modules/views/views.services.yml
Drupal\views\Plugin\ViewsHandlerManager
plugin.manager.views.filter in core/modules/views/views.services.yml
Drupal\views\Plugin\ViewsHandlerManager
plugin.manager.views.join in core/modules/views/views.services.yml
Drupal\views\Plugin\ViewsHandlerManager

... See full list

File

core/modules/views/src/Plugin/ViewsHandlerManager.php, line 16

Namespace

Drupal\views\Plugin
View source
class ViewsHandlerManager extends DefaultPluginManager implements FallbackPluginManagerInterface {

  /**
   * The views data cache.
   *
   * @var \Drupal\views\ViewsData
   */
  protected $viewsData;

  /**
   * The handler type.
   *
   * @var string
   *
   * @see \Drupal\views\ViewExecutable::getHandlerTypes().
   */
  protected $handlerType;

  /**
   * Constructs a ViewsHandlerManager object.
   *
   * @param string $handler_type
   *   The plugin type, for example filter.
   * @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\views\ViewsData $views_data
   *   The views data cache.
   * @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($handler_type, \Traversable $namespaces, ViewsData $views_data, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    $plugin_definition_annotation_name = 'Drupal\\views\\Annotation\\Views' . Container::camelize($handler_type);
    $plugin_interface = 'Drupal\\views\\Plugin\\views\\ViewsHandlerInterface';
    if ($handler_type == 'join') {
      $plugin_interface = 'Drupal\\views\\Plugin\\views\\join\\JoinPluginInterface';
    }
    parent::__construct("Plugin/views/{$handler_type}", $namespaces, $module_handler, $plugin_interface, $plugin_definition_annotation_name);
    $this
      ->setCacheBackend($cache_backend, "views:{$handler_type}");
    $this
      ->alterInfo('views_plugins_' . $handler_type);
    $this->viewsData = $views_data;
    $this->handlerType = $handler_type;
    $this->defaults = [
      'plugin_type' => $handler_type,
    ];
  }

  /**
   * Fetches a handler from the data cache.
   *
   * @param array $item
   *   An associative array representing the handler to be retrieved:
   *   - table: The name of the table containing the handler.
   *   - field: The name of the field the handler represents.
   * @param string|null $override
   *   (optional) Override the actual handler object with this plugin ID. Used for
   *   aggregation when the handler is redirected to the aggregation handler.
   *
   * @return \Drupal\views\Plugin\views\ViewsHandlerInterface
   *   An instance of a handler object. May be a broken handler instance.
   */
  public function getHandler($item, $override = NULL) {
    $table = $item['table'];
    $field = $item['field'];

    // Get the plugin manager for this type.
    $data = $table ? $this->viewsData
      ->get($table) : $this->viewsData
      ->getAll();
    if (isset($data[$field][$this->handlerType])) {
      $definition = $data[$field][$this->handlerType];
      foreach ([
        'group',
        'title',
        'title short',
        'label',
        'help',
        'real field',
        'real table',
        'entity type',
        'entity field',
      ] as $key) {
        if (!isset($definition[$key])) {

          // First check the field level.
          if (!empty($data[$field][$key])) {
            $definition[$key] = $data[$field][$key];
          }
          elseif (!empty($data['table'][$key])) {
            $definition_key = $key === 'entity type' ? 'entity_type' : $key;
            $definition[$definition_key] = $data['table'][$key];
          }
        }
      }

      // @todo This is crazy. Find a way to remove the override functionality.
      $plugin_id = $override ?: $definition['id'];

      // Try to use the overridden handler.
      $handler = $this
        ->createInstance($plugin_id, $definition);
      if ($override && method_exists($handler, 'broken') && $handler
        ->broken()) {
        $handler = $this
          ->createInstance($definition['id'], $definition);
      }
      return $handler;
    }

    // Finally, use the 'broken' handler.
    return $this
      ->createInstance('broken', [
      'original_configuration' => $item,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    $instance = parent::createInstance($plugin_id, $configuration);
    if ($instance instanceof HandlerBase) {
      $instance
        ->setModuleHandler($this->moduleHandler);
      $instance
        ->setViewsData($this->viewsData);
    }
    return $instance;
  }

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

}

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::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 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
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::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 6
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.
ViewsHandlerManager::$handlerType protected property The handler type.
ViewsHandlerManager::$viewsData protected property The views data cache.
ViewsHandlerManager::createInstance public function Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
ViewsHandlerManager::getFallbackPluginId public function Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
ViewsHandlerManager::getHandler public function Fetches a handler from the data cache.
ViewsHandlerManager::__construct public function Constructs a ViewsHandlerManager object. Overrides DefaultPluginManager::__construct