interface CategorizingPluginManagerInterface

Defines an interface for plugin managers that categorize plugin definitions.

Hierarchy

Expanded class hierarchy of CategorizingPluginManagerInterface

All classes that implement CategorizingPluginManagerInterface

7 files declare their use of CategorizingPluginManagerInterface
ActionManager.php in core/lib/Drupal/Core/Action/ActionManager.php
BlockManagerInterface.php in core/lib/Drupal/Core/Block/BlockManagerInterface.php
CategorizingPluginManagerTraitTest.php in core/tests/Drupal/Tests/Core/Plugin/CategorizingPluginManagerTraitTest.php
ComponentPluginManager.php in core/lib/Drupal/Core/Theme/ComponentPluginManager.php
ConditionManager.php in core/lib/Drupal/Core/Condition/ConditionManager.php

... See full list

File

View on git.drupalcode.org

core/lib/Drupal/Component/Plugin/CategorizingPluginManagerInterface.php, line 8

Namespace

Drupal\Component\Plugin
View source 
interface CategorizingPluginManagerInterface extends PluginManagerInterface {
  
  /**
   * Gets the names of all categories.
   *
   * @return string[]
   *   An array of translated categories, sorted alphabetically.
   */
  public function getCategories();
  
  /**
   * Gets sorted plugin definitions.
   *
   * @param array[]|null $definitions
   *   (optional) The plugin definitions to sort. If omitted, all plugin
   *   definitions are used.
   *
   * @return array[]
   *   An array of plugin definitions, sorted by category and label.
   */
  public function getSortedDefinitions(?array $definitions = NULL);
  
  /**
   * Gets sorted plugin definitions grouped by category.
   *
   * In addition to grouping, both categories and its entries are sorted,
   * whereas plugin definitions are sorted by label.
   *
   * @param array[]|null $definitions
   *   (optional) The plugin definitions to group. If omitted, all plugin
   *   definitions are used.
   *
   * @return array[]
   *   Keys are category names, and values are arrays of which the keys are
   *   plugin IDs and the values are plugin definitions.
   */
  public function getGroupedDefinitions(?array $definitions = NULL);

}

Members

Title Modifiers Object type Summary Overrides
CategorizingPluginManagerInterface::getCategories public function Gets the names of all categories. 1
CategorizingPluginManagerInterface::getGroupedDefinitions public function Gets sorted plugin definitions grouped by category. 2
CategorizingPluginManagerInterface::getSortedDefinitions public function Gets sorted plugin definitions. 2
DiscoveryInterface::getDefinition public function Gets a specific plugin definition. 4
DiscoveryInterface::getDefinitions public function Gets the definition of all plugins for this type. 3
DiscoveryInterface::hasDefinition public function Indicates if a specific plugin definition exists. 1
FactoryInterface::createInstance public function Creates a plugin instance based on the provided ID and configuration. 6
MapperInterface::getInstance public function Gets or creates a plugin instance that satisfies the given options. 3

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