You are here

class ReplicationFilter in Replication 8

Same name and namespace in other branches
  1. 8.2 src/Annotation/ReplicationFilter.php \Drupal\replication\Annotation\ReplicationFilter

Defines a ReplicationFilter annotation object.

Plugin Namespace: Plugin\ReplicationFilter

For a working example, see \Drupal\replication\Plugin\ReplicationFilter\PublishedFilter

Hierarchy

Expanded class hierarchy of ReplicationFilter

See also

\Drupal\replication\Plugin\ReplicationFilterInterface

\Drupal\replication\Plugin\ReplicationFilterManager

Plugin API

4 classes are annotated with ReplicationFilter
DocIdsFilter in src/Plugin/ReplicationFilter/DocIdsFilter.php
Provides filtering by UUID.
EntityTypeFilter in src/Plugin/ReplicationFilter/EntityTypeFilter.php
Provides a filter based on entity type.
PublishedFilter in src/Plugin/ReplicationFilter/PublishedFilter.php
Provides a filter for published entities.
UuidFilter in src/Plugin/ReplicationFilter/UuidFilter.php
Provides filtering by UUID.

File

src/Annotation/ReplicationFilter.php, line 21

Namespace

Drupal\replication\Annotation
View source
class ReplicationFilter extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the ReplicationFilter plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * A short description of the ReplicationFilter plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Namesort descending Modifiers Type Description Overrides
Plugin::$definition protected property The plugin definition read from the class annotation. 1
Plugin::get public function Gets the value of an annotation. Overrides AnnotationInterface::get 5
Plugin::getClass public function Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId public function Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider public function Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse protected function Parses an annotation into its definition.
Plugin::setClass public function Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider public function Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct public function Constructs a Plugin object. 2
ReplicationFilter::$description public property A short description of the ReplicationFilter plugin.
ReplicationFilter::$id public property The plugin ID.
ReplicationFilter::$label public property The human-readable name of the ReplicationFilter plugin.