Version 1

[yaffs-website] / web / modules / contrib / diff / src / FieldReferenceInterface.php

diff --git a/web/modules/contrib/diff/src/FieldReferenceInterface.php b/web/modules/contrib/diff/src/FieldReferenceInterface.php
new file mode 100644 (file)
index 0000000..92daf34
--- /dev/null
+++ b/web/modules/contrib/diff/src/FieldReferenceInterface.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace Drupal\diff;
+
+use Drupal\Core\Field\FieldItemListInterface;
+use Drupal\Core\Plugin\PluginFormInterface;
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+
+/**
+ * Provides referenced entities to recurse in diff.
+ */
+interface FieldReferenceInterface extends PluginFormInterface, ConfigurablePluginInterface {
+
+  /**
+   * Builds an array of entities.
+   *
+   * This method is responsible for transforming a FieldItemListInterface object
+   * into an array of entities. The resulted array of entities is then used when
+   * parsing the entity to get a clean array of fields that will be compared.
+   *
+   * @param \Drupal\Core\Field\FieldItemListInterface $field_items
+   *   Represents an entity field.
+   *
+   * @return \Drupal\Core\Entity\EntityInterface[]
+   *   An array of entities to be compared. If an empty array is returned it
+   *   means that a field is either empty or no properties need to be compared
+   *   for that field.
+   */
+  public function getEntitiesToDiff(FieldItemListInterface $field_items);
+
+}