class EntityReferenceRevisionsFieldDiffBuilder in Entity Reference Revisions 8

This plugins offers the possibility to compare ERR fields.

Plugin annotation

@FieldDiffBuilder(
  id = "entity_reference_revisions_field_diff_builder",
  label = @Translation("Field Diff for Paragraphs"),
  field_types = {
    "entity_reference_revisions"
  },
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\diff\FieldDiffBuilderBase implements ContainerFactoryPluginInterface, FieldDiffBuilderInterface
      • class \Drupal\entity_reference_revisions\Plugin\diff\Field\EntityReferenceRevisionsFieldDiffBuilder implements FieldReferenceInterface

File

src/Plugin/diff/Field/EntityReferenceRevisionsFieldDiffBuilder.php, line 20

Namespace

Drupal\entity_reference_revisions\Plugin\diff\Field

class EntityReferenceRevisionsFieldDiffBuilder extends FieldDiffBuilderBase implements FieldReferenceInterface {

  /**
   * {@inheritdoc}
   */
  public function build(FieldItemListInterface $field_items) {
    $result_text = array();
    $item_counter = 0;

    /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $field_item */
    foreach ($field_items as $field_key => $field_item) {
      if (!$field_item
        ->isEmpty() && $field_item->entity) {
        $parsed_text = $this->entityParser
          ->parseEntity($field_item->entity);
        if (is_array($parsed_text)) {
          foreach ($parsed_text as $field_id => $field) {
            foreach ($field as $id => $text) {
              $result_text[$item_counter + $id] = $text;
            }
            $item_counter = $item_counter + $id + 1;
          }
        }
      }
    }
    return $result_text;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntitiesToDiff(FieldItemListInterface $field_items) {

    /** @var \Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem $field_item */
    $entities = [];
    foreach ($field_items as $field_key => $field_item) {
      if (!$field_item
        ->isEmpty() && $field_item->entity) {
        $entities[$field_key] = $field_item->entity;
      }
    }
    return $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
EntityReferenceRevisionsFieldDiffBuilder::build	public	function	Builds an array of strings. Overrides FieldDiffBuilderInterface::build
EntityReferenceRevisionsFieldDiffBuilder::getEntitiesToDiff	public	function	Builds an array of entities. Overrides FieldReferenceInterface::getEntitiesToDiff
FieldDiffBuilderBase::$configFactory	protected	property	Contains the configuration object factory.
FieldDiffBuilderBase::$entityParser	protected	property	The entity parser.
FieldDiffBuilderBase::$entityTypeManager	protected	property	The entity type manager.
FieldDiffBuilderBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm	8
FieldDiffBuilderBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
FieldDiffBuilderBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	8
FieldDiffBuilderBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldDiffBuilderBase::isApplicable	public static	function	Returns if the plugin can be used for the provided field. Overrides FieldDiffBuilderInterface::isApplicable	2
FieldDiffBuilderBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldDiffBuilderBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	8
FieldDiffBuilderBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
FieldDiffBuilderBase::__construct	public	function	Constructs a FieldDiffBuilderBase object. Overrides PluginBase::__construct	1
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.
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.