class PublishedFilter in Replication 8

Provides a filter for published entities.

Use the configuration "include_unpublishable_entities" to determine what happens to entities that do not have a "status" field, if set to TRUE they will be included by the filter, else excluded.

Plugin annotation

@ReplicationFilter(
  id = "published",
  label = @Translation("Filter Published Nodes"),
  description = @Translation("Replicate only nodes that are published.")
)

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\PublishedFilter implements ContainerFactoryPluginInterface

File

src/Plugin/ReplicationFilter/PublishedFilter.php, line 24

Namespace

Drupal\replication\Plugin\ReplicationFilter

class PublishedFilter extends ReplicationFilterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity type manager to check for "status" entity key.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new PublishedFilter.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function filter(EntityInterface $entity) {

    // @todo handle translations?
    // @todo is there an easier way to tell if an entity is published?
    $definition = $this->entityTypeManager
      ->getDefinition($entity
      ->getEntityTypeId());
    if ($definition
      ->hasKey('status')) {
      $field_name = $definition
        ->getKey('status');
      $field_definition = $entity
        ->getFieldDefinition($field_name);
      $property = $field_definition
        ->getFieldStorageDefinition()
        ->getMainPropertyName();
      return (bool) $entity
        ->get($field_name)->{$property};
    }

    // Determine what to do with entities without a 'status' field.
    $configuration = $this
      ->getConfiguration();
    return $configuration['include_unpublishable_entities'];
  }

}

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.
PublishedFilter::$entityTypeManager	protected	property	The entity type manager to check for "status" entity key.
PublishedFilter::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PublishedFilter::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurablePluginInterface::defaultConfiguration
PublishedFilter::filter	public	function	Filter the given entity. Overrides ReplicationFilterInterface::filter
PublishedFilter::__construct	public	function	Constructs a new PublishedFilter. Overrides PluginBase::__construct
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.