interface FieldReferenceInterface in Diff 8

Provides referenced entities to recurse in diff.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Component\Plugin\ConfigurableInterface
  • interface \Drupal\diff\FieldReferenceInterface

File

src/FieldReferenceInterface.php, line 12

Namespace

Drupal\diff

interface FieldReferenceInterface extends PluginFormInterface, ConfigurableInterface {

  /**
   * 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);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
FieldReferenceInterface::getEntitiesToDiff	public	function	Builds an array of entities.
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18