interface RulesUiManagerInterface in Rules 8.3

Interface for the 'rules_ui' plugin manager.

RulesUI plugins allow the definition of multiple RulesUIs instances, possibly being included in some other UI.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\rules\Ui\RulesUiManagerInterface

2 files declare their use of RulesUiManagerInterface

RulesUiRouteEnhancer.php in src/Routing/RulesUiRouteEnhancer.php

RulesUiRouteSubscriber.php in src/Routing/RulesUiRouteSubscriber.php

File

src/Ui/RulesUiManagerInterface.php, line 13

Namespace

Drupal\rules\Ui

interface RulesUiManagerInterface extends PluginManagerInterface {

  /**
   * Creates a pre-configured instance of a plugin.
   *
   * @param string $plugin_id
   *   The ID of the plugin being instantiated.
   * @param array $configuration
   *   An array of configuration relevant to the plugin instance.
   *
   * @return \Drupal\rules\Ui\RulesUiHandlerInterface
   *   A fully configured plugin instance.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginException
   *   If the instance cannot be created, such as if the ID is invalid.
   */
  public function createInstance($plugin_id, array $configuration = []);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\rules\Ui\RulesUiDefinition|null
   *   A plugin definition, or NULL if the plugin ID is invalid and
   *   $exception_on_invalid is FALSE.
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\rules\Ui\RulesUiDefinition[]
   *   An array of plugin definitions (empty array if no definitions were
   *   found). Keys are plugin IDs.
   */
  public function getDefinitions();

}

Members

Name	Modifiers	Type	Description	Overrides
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4
RulesUiManagerInterface::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance
RulesUiManagerInterface::getDefinition	public	function	Overrides DiscoveryInterface::getDefinition
RulesUiManagerInterface::getDefinitions	public	function	Overrides DiscoveryInterface::getDefinitions