You are here

Home » API reference » Config Entity Revisions 8 » ConfigEntityRevisionsDiffController.php

class ConfigEntityRevisionsDiffController in Config Entity Revisions 8

Same name and namespace in other branches
  1. 1.x src/ConfigEntityRevisionsDiffController.php \Drupal\config_entity_revisions\ConfigEntityRevisionsDiffController

Class ConfigEntityRevisionsDiffController.

Compare revisions of an entity.

Hierarchy

Expanded class hierarchy of ConfigEntityRevisionsDiffController

File

src/ConfigEntityRevisionsDiffController.php, line 17

Namespace

Drupal\config_entity_revisions
View source 
class ConfigEntityRevisionsDiffController extends PluginRevisionController {

  /**
   * Constructs a PluginRevisionController object.
   *
   * @param \Drupal\diff\DiffEntityComparison $entity_comparison
   *   The diff entity comparison service.
   * @param \Drupal\diff\DiffLayoutManager $diff_layout_manager
   *   The diff layout service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  public function __construct(DiffEntityComparison $entity_comparison, DiffLayoutManager $diff_layout_manager, RequestStack $request_stack, EntityTypeManagerInterface $entityTypeManager) {
    parent::__construct($entity_comparison, $diff_layout_manager, $request_stack);
    $this->entityTypeManager = $entityTypeManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('diff.entity_comparison'), $container
      ->get('plugin.manager.diff.layout'), $container
      ->get('request_stack'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Returns a table which shows the differences between two entity revisions.
   *
   * @param string $config_entity_type
   *   The type of entity to compare
   * @param mixed $config_entity_id
   *  The ID of the entity.
   * @param int $left_revision
   *   Id of the revision from the left.
   * @param int $right_revision
   *   Id of the revision from the right.
   * @param string $filter
   *   If $filter == 'raw' raw text is compared (including html tags)
   *   If $filter == 'raw-plain' markdown function is applied to the text before comparison.
   *
   * @return array
   *   Table showing the diff between the two node revisions.
   */
  public function compareConfigEntityRevisions($config_entity_type, $config_entity_id, $left_revision, $right_revision, $filter) {
    $entity_type = $this->entityTypeManager
      ->getDefinition($config_entity_type);
    $class = $entity_type
      ->get('class');
    if (!in_array('Drupal\\config_entity_revisions\\ConfigEntityRevisionsInterface', class_implements($class))) {
      return [];
    }
    $storage = $this->entityTypeManager
      ->getStorage($config_entity_type);
    $route_match = \Drupal::routeMatch();
    $left_revision = $storage
      ->loadRevision($left_revision);
    $right_revision = $storage
      ->loadRevision($right_revision);
    $build = $this
      ->compareEntityRevisions($route_match, $left_revision, $right_revision, $filter);
    return $build;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityRevisionsDiffController::compareConfigEntityRevisions public function Returns a table which shows the differences between two entity revisions.
ConfigEntityRevisionsDiffController::create public static function Instantiates a new instance of this class. Overrides PluginRevisionController::create
ConfigEntityRevisionsDiffController::__construct public function Constructs a PluginRevisionController object. Overrides PluginRevisionController::__construct
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginRevisionController::$config protected property Wrapper object for writing/reading configuration from diff.plugins.yml.
PluginRevisionController::$diffLayoutManager protected property The field diff layout plugin manager service.
PluginRevisionController::$entityComparison protected property The diff entity comparison service.
PluginRevisionController::$requestStack protected property The request stack.
PluginRevisionController::buildLayoutNavigation protected function Builds a navigation dropdown button between the layout plugins.
PluginRevisionController::buildRevisionsNavigation protected function Creates navigation links between the previous changes and the new ones.
PluginRevisionController::compareEntityRevisions public function Returns a table which shows the differences between two entity revisions.
PluginRevisionController::diffRoute public static function Creates an url object for diff.
PluginRevisionController::getRevisionIds public function Get all the revision ids of given entity id.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.