class UuidFilter in Replication 8

Provides filtering by UUID.

Use the configuration "uuids" which is an array of uuids, e.g. "101,102".

Note: if the entity a UUID refers to references another entity, that referenced entity's UUID must also be included in order to maintain data integrity.

Plugin annotation

@ReplicationFilter(
  id = "uuid",
  label = @Translation("Filter UUIDs"),
  description = @Translation("Replicate only entities in the set of UUIDs.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\replication\Plugin\ReplicationFilter\ReplicationFilterBase implements ReplicationFilterInterface
      • class \Drupal\replication\Plugin\ReplicationFilter\UuidFilter

1 file declares its use of UuidFilter

UuidFilterTest.php in tests/src/Unit/Plugin/ReplicationFilter/UuidFilterTest.php

File

src/Plugin/ReplicationFilter/UuidFilter.php, line 22

Namespace

Drupal\replication\Plugin\ReplicationFilter

class UuidFilter extends ReplicationFilterBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'uuids' => [],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function filter(EntityInterface $entity) {
    $configuration = $this
      ->getConfiguration();
    return in_array($entity
      ->uuid(), $configuration['uuids']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ReplicationFilterBase::$description	protected	property	The description of what the replication filter does.
ReplicationFilterBase::$label	protected	property	The human readable label for the replication filter.
ReplicationFilterBase::calculateDependencies	public	function	Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ReplicationFilterBase::getConfiguration	public	function	For replication filters, the plugin configuration contains what would be passed as "query_params" to a CouchDB filter function. Overrides ConfigurablePluginInterface::getConfiguration
ReplicationFilterBase::getDescription	public	function	Get the description of what the filter does. Overrides ReplicationFilterInterface::getDescription
ReplicationFilterBase::getLabel	public	function	Get the label for the filter. Overrides ReplicationFilterInterface::getLabel
ReplicationFilterBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurablePluginInterface::setConfiguration
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
UuidFilter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration
UuidFilter::filter	public	function	Filter the given entity. Overrides ReplicationFilterInterface::filter