class VisualInlineDiffLayout in Diff 8

Provides Visual Inline diff layout.

Plugin annotation


@DiffLayoutBuilder(
  id = "visual_inline",
  label = @Translation("Visual Inline"),
  description = @Translation("Visual layout, displays revision comparison using the entity type view mode."),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\diff\DiffLayoutBase implements ContainerFactoryPluginInterface, DiffLayoutInterface uses StringTranslationTrait
  - class \Drupal\diff\Plugin\diff\Layout\VisualInlineDiffLayout

Expanded class hierarchy of VisualInlineDiffLayout

File

src/Plugin/diff/Layout/VisualInlineDiffLayout.php, line 29

Namespace

Drupal\diff\Plugin\diff\Layout

View source

class VisualInlineDiffLayout extends DiffLayoutBase {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The diff entity comparison service.
   *
   * @var \Drupal\diff\DiffEntityComparison
   */
  protected $entityComparison;

  /**
   * The html diff service.
   *
   * @var \HtmlDiffAdvancedInterface
   */
  protected $htmlDiff;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * Constructs a VisualInlineDiffLayout object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config
   *   The configuration factory object.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\diff\DiffEntityParser $entity_parser
   *   The entity parser.
   * @param \Drupal\Core\DateTime\DateFormatter $date
   *   The date service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   * @param \Drupal\diff\DiffEntityComparison $entity_comparison
   *   The diff entity comparison service.
   * @param \HtmlDiffAdvancedInterface $html_diff
   *   The html diff service.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config, EntityTypeManagerInterface $entity_type_manager, DiffEntityParser $entity_parser, DateFormatter $date, RendererInterface $renderer, DiffEntityComparison $entity_comparison, HtmlDiffAdvancedInterface $html_diff, RequestStack $request_stack, EntityDisplayRepositoryInterface $entity_display_repository) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config, $entity_type_manager, $entity_parser, $date);
    $this->renderer = $renderer;
    $this->entityComparison = $entity_comparison;
    $storage = PhpStorageFactory::get('html_purifier_serializer');
    if (!$storage
      ->exists('cache.php')) {
      $storage
        ->save('cache.php', 'dummy');
    }
    $html_diff
      ->getConfig()
      ->setPurifierCacheLocation(dirname($storage
      ->getFullPath('cache.php')));
    $this->htmlDiff = $html_diff;
    $this->requestStack = $request_stack;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('entity_type.manager'), $container
      ->get('diff.entity_parser'), $container
      ->get('date.formatter'), $container
      ->get('renderer'), $container
      ->get('diff.entity_comparison'), $container
      ->get('diff.html_diff'), $container
      ->get('request_stack'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public function build(ContentEntityInterface $left_revision, ContentEntityInterface $right_revision, ContentEntityInterface $entity) {

    // Build the revisions data.
    $build = $this
      ->buildRevisionsData($left_revision, $right_revision);
    $this->entityTypeManager
      ->getStorage($entity
      ->getEntityTypeId())
      ->resetCache([
      $entity
        ->id(),
    ]);

    // Build the view modes filter.
    $options = [];

    // Get all view modes for entity type.
    $view_modes = $this->entityDisplayRepository
      ->getViewModeOptionsByBundle($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    foreach ($view_modes as $view_mode => $view_mode_info) {

      // Skip view modes that are not used in the front end.
      if (in_array($view_mode, [
        'rss',
        'search_index',
      ])) {
        continue;
      }
      $options[$view_mode] = [
        'title' => $view_mode_info,
        'url' => PluginRevisionController::diffRoute($entity, $left_revision
          ->getRevisionId(), $right_revision
          ->getRevisionId(), 'visual_inline', [
          'view_mode' => $view_mode,
        ]),
      ];
    }
    $active_option = array_keys($options);
    $active_view_mode = $this->requestStack
      ->getCurrentRequest()->query
      ->get('view_mode') ?: reset($active_option);
    $filter = $options[$active_view_mode];
    unset($options[$active_view_mode]);
    array_unshift($options, $filter);
    $build['controls']['view_mode'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('View mode'),
      '#wrapper_attributes' => [
        'class' => 'diff-controls__item',
      ],
      'filter' => [
        '#type' => 'operations',
        '#links' => $options,
      ],
    ];
    $view_builder = $this->entityTypeManager
      ->getViewBuilder($entity
      ->getEntityTypeId());

    // Trigger exclusion of interactive items like on preview.
    $left_revision->in_preview = TRUE;
    $right_revision->in_preview = TRUE;
    $left_view = $view_builder
      ->view($left_revision, $active_view_mode);
    $right_view = $view_builder
      ->view($right_revision, $active_view_mode);

    // Avoid render cache from being built.
    unset($left_view['#cache']);
    unset($right_view['#cache']);
    $html_1 = $this->renderer
      ->render($left_view);
    $html_2 = $this->renderer
      ->render($right_view);
    $this->htmlDiff
      ->setOldHtml($html_1);
    $this->htmlDiff
      ->setNewHtml($html_2);
    $this->htmlDiff
      ->build();
    $build['diff'] = [
      '#markup' => $this->htmlDiff
        ->getDifference(),
      '#weight' => 10,
    ];
    $build['#attached']['library'][] = 'diff/diff.visual_inline';
    return $build;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DiffLayoutBase::$configFactory	protected	property	Contains the configuration object factory.
DiffLayoutBase::$date	protected	property	The date service.
DiffLayoutBase::$entityParser	protected	property	The entity parser.
DiffLayoutBase::$entityTypeManager	protected	property	The entity type manager.
DiffLayoutBase::applyMarkdown	protected	function	Applies a markdown function to a string.
DiffLayoutBase::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
DiffLayoutBase::buildFilterNavigation	protected	function	Build the filter navigation for the diff comparison.
DiffLayoutBase::buildRevisionData	protected	function	Build the revision link for a revision.
DiffLayoutBase::buildRevisionLink	protected	function	Build the revision link for a revision.
DiffLayoutBase::buildRevisionsData	public	function	Build the revision link for the compared revisions.
DiffLayoutBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
DiffLayoutBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
DiffLayoutBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
DiffLayoutBase::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
DiffLayoutBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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.
VisualInlineDiffLayout::$entityComparison	protected	property	The diff entity comparison service.
VisualInlineDiffLayout::$entityDisplayRepository	protected	property	The entity display repository.
VisualInlineDiffLayout::$htmlDiff	protected	property	The html diff service.
VisualInlineDiffLayout::$renderer	protected	property	The renderer.
VisualInlineDiffLayout::$requestStack	protected	property	The request stack.
VisualInlineDiffLayout::build	public	function	Builds a diff comparison between two revisions. Overrides DiffLayoutInterface::build
VisualInlineDiffLayout::create	public static	function	Creates an instance of the plugin. Overrides DiffLayoutBase::create
VisualInlineDiffLayout::__construct	public	function	Constructs a VisualInlineDiffLayout object. Overrides DiffLayoutBase::__construct

You are here

class VisualInlineDiffLayout in Diff 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation