www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/diff/src/DiffLayoutInterface.php

   1 <?php
   2
   3 namespace Drupal\diff;
   4
   5 use Drupal\Core\Entity\ContentEntityInterface;
   6 use Drupal\Core\Plugin\PluginFormInterface;
   7 use Drupal\Component\Plugin\ConfigurablePluginInterface;
   8
   9 /**
  10  * Builds a diff layout.
  11  */
  12 interface DiffLayoutInterface extends PluginFormInterface, ConfigurablePluginInterface {
  13
  14   /**
  15    * Builds a diff comparison between two revisions.
  16    *
  17    * This method is responsible for building the diff comparison between
  18    * revisions of the same entity. It can build a table, navigation links and
  19    * headers of a diff comparison.
  20    *
  21    * @param \Drupal\Core\Entity\ContentEntityInterface $left_revision
  22    *   The left revision.
  23    * @param \Drupal\Core\Entity\ContentEntityInterface $right_revision
  24    *   The right revision.
  25    * @param \Drupal\Core\Entity\ContentEntityInterface $entity
  26    *   The entity.
  27    *
  28    * @return array
  29    *   The modified build array that the plugin builds.
  30    */
  31   public function build(ContentEntityInterface $left_revision, ContentEntityInterface $right_revision, ContentEntityInterface $entity);
  32
  33 }