You are here

interface RulesUiComponentProviderInterface in Rules 8.3

Interface for objects providing components for editing.

Usually, this would be implemented by a config entity storing the component.

Hierarchy

Expanded class hierarchy of RulesUiComponentProviderInterface

All classes that implement RulesUiComponentProviderInterface

2 files declare their use of RulesUiComponentProviderInterface
ReactionRuleConfig.php in src/Entity/ReactionRuleConfig.php
RulesComponentConfig.php in src/Entity/RulesComponentConfig.php

File

src/Ui/RulesUiComponentProviderInterface.php, line 12

Namespace

Drupal\rules\Ui
View source
interface RulesUiComponentProviderInterface {

  /**
   * Gets the Rules component to be edited.
   *
   * @return \Drupal\rules\Engine\RulesComponent
   *   The Rules component.
   */
  public function getComponent();

  /**
   * Updates the configuration based upon the given component.
   *
   * @param \Drupal\rules\Engine\RulesComponent $component
   *   The component containing the configuration to set.
   *
   * @return $this
   */
  public function updateFromComponent(RulesComponent $component);

}

Members

Namesort descending Modifiers Type Description Overrides
RulesUiComponentProviderInterface::getComponent public function Gets the Rules component to be edited. 2
RulesUiComponentProviderInterface::updateFromComponent public function Updates the configuration based upon the given component. 2