ReplicationFilterInterface.php in Replication 8.2
Same filename and directory in other branches
Namespace
Drupal\replication\PluginFile
src/Plugin/ReplicationFilterInterface.phpView source
<?php
namespace Drupal\replication\Plugin;
use Drupal\Component\Plugin\ConfigurablePluginInterface;
use Drupal\Component\Plugin\PluginInspectionInterface;
use Drupal\Core\Entity\EntityInterface;
/**
* Defines a replication filter.
*
* Replication filters are used to filter out entities from a changeset during
* replication.
*/
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);
}
Interfaces
Name | Description |
---|---|
ReplicationFilterInterface | Defines a replication filter. |