interface ReplicationFilterInterface in Replication 8

Defines a replication filter.

Replication filters are used to filter out entities from a changeset during replication.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\ConfigurablePluginInterface
  • interface \Drupal\replication\Plugin\ReplicationFilterInterface

1 file declares its use of ReplicationFilterInterface

ReplicationFilterBase.php in src/Plugin/ReplicationFilter/ReplicationFilterBase.php

File

src/Plugin/ReplicationFilterInterface.php, line 15

Namespace

Drupal\replication\Plugin

interface ReplicationFilterInterface extends PluginInspectionInterface, ConfigurablePluginInterface {

  /**
   * Get the label for the filter.
   *
   * @return string
   */
  public function getLabel();

  /**
   * Get the description of what the filter does.
   *
   * @return string
   */
  public function getDescription();

  /**
   * Filter the given entity.
   *
   * @param EntityInterface $entity
   *   The entity to filter.
   *
   * @return bool
   *   Return TRUE if it should be included, else FALSE.
   */
  public function filter(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurablePluginInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	1
ConfigurablePluginInterface::getConfiguration	public	function	Gets this plugin's configuration.	1
ConfigurablePluginInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	1
DependentPluginInterface::calculateDependencies	public	function	Calculates dependencies for the configured plugin.	19
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
ReplicationFilterInterface::filter	public	function	Filter the given entity.	4
ReplicationFilterInterface::getDescription	public	function	Get the description of what the filter does.	1
ReplicationFilterInterface::getLabel	public	function	Get the label for the filter.	1