You are here

Home » API reference » Diff 8 » DiffLayoutBase.php

abstract class DiffLayoutBase in Diff 8

Base class for diff layout plugins.

Hierarchy

Expanded class hierarchy of DiffLayoutBase

3 files declare their use of DiffLayoutBase
SplitFieldsDiffLayout.php in src/Plugin/diff/Layout/SplitFieldsDiffLayout.php
UnifiedFieldsDiffLayout.php in src/Plugin/diff/Layout/UnifiedFieldsDiffLayout.php
VisualInlineDiffLayout.php in src/Plugin/diff/Layout/VisualInlineDiffLayout.php

File

src/DiffLayoutBase.php, line 25

Namespace

Drupal\diff
View source 
abstract class DiffLayoutBase extends PluginBase implements DiffLayoutInterface, ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * Contains the configuration object factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The entity parser.
   *
   * @var \Drupal\diff\DiffEntityParser
   */
  protected $entityParser;

  /**
   * The date service.
   *
   * @var \Drupal\Core\Datetime\DateFormatter
   */
  protected $date;

  /**
   * Constructs a DiffLayoutBase 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config, EntityTypeManagerInterface $entity_type_manager, DiffEntityParser $entity_parser, DateFormatter $date) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configFactory = $config;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityParser = $entity_parser;
    $this->date = $date;
    $this->configuration += $this
      ->defaultConfiguration();
  }

  /**
   * {@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'));
  }

  /**
   * Build the revision link for a revision.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $revision
   *   A revision where to add a link.
   *
   * @return \Drupal\Core\Link
   *   Header link for a revision in the table.
   */
  protected function buildRevisionLink(ContentEntityInterface $revision) {
    if ($revision instanceof RevisionLogInterface) {
      $revision_date = $this->date
        ->format($revision
        ->getRevisionCreationTime(), 'short');
      $revision_link = Link::fromTextAndUrl($revision_date, $revision
        ->toUrl('revision'))
        ->toString();
    }
    else {
      $revision_link = Link::fromTextAndUrl($revision
        ->label(), $revision
        ->toUrl('revision'))
        ->toString();
    }
    return $revision_link;
  }

  /**
   * Build the revision link for the compared revisions.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $left_revision
   *   Left revision that is compared.
   * @param \Drupal\Core\Entity\ContentEntityInterface $right_revision
   *   Right revision that is compared.
   *
   * @return array
   *   Header link for a revision in the revision comparison display.
   */
  public function buildRevisionsData(ContentEntityInterface $left_revision, ContentEntityInterface $right_revision) {
    $right_revision = $this
      ->buildRevisionData($right_revision);
    $right_revision['#prefix'] = '<div class="diff-revision__items-group">';
    $right_revision['#suffix'] = '</div>';
    $left_revision = $this
      ->buildRevisionData($left_revision);
    $left_revision['#prefix'] = '<div class="diff-revision__items-group">';
    $left_revision['#suffix'] = '</div>';

    // Show the revisions that are compared.
    return [
      'header' => [
        'diff_revisions' => [
          '#type' => 'item',
          '#title' => $this
            ->t('Comparing'),
          '#wrapper_attributes' => [
            'class' => 'diff-revision',
          ],
          'items' => [
            '#prefix' => '<div class="diff-revision__items">',
            '#suffix' => '</div>',
            'right_revision' => $right_revision,
            'left_revision' => $left_revision,
          ],
        ],
      ],
    ];
  }

  /**
   * Build the revision link for a revision.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $revision
   *   Left revision that is compared.
   *
   * @return array
   *   Revision data about author, creation date and log.
   */
  protected function buildRevisionData(ContentEntityInterface $revision) {
    if ($revision instanceof RevisionLogInterface) {
      $revision_log = Xss::filter($revision
        ->getRevisionLogMessage());
      $user_id = $revision
        ->getRevisionUserId();
      $revision_link['date'] = [
        '#type' => 'link',
        '#title' => $this->date
          ->format($revision
          ->getRevisionCreationTime(), 'short'),
        '#url' => $revision
          ->toUrl('revision'),
        '#prefix' => '<div class="diff-revision__item diff-revision__item-date">',
        '#suffix' => '</div>',
      ];
      $revision_link['author'] = [
        '#type' => 'link',
        '#title' => $revision
          ->getRevisionUser()
          ->getDisplayName(),
        '#url' => Url::fromUri(\Drupal::request()
          ->getUriForPath('/user/' . $user_id)),
        '#theme' => 'username',
        '#account' => $revision
          ->getRevisionUser(),
        '#prefix' => '<div class="diff-revision__item diff-revision__item-author">',
        '#suffix' => '</div>',
      ];
      if ($revision_log) {
        $revision_link['message'] = [
          '#type' => 'markup',
          '#prefix' => '<div class="diff-revision__item diff-revision__item-message">',
          '#suffix' => '</div>',
          '#markup' => $revision_log,
        ];
      }
    }
    else {
      $revision_link['label'] = [
        '#type' => 'link',
        '#title' => $revision
          ->label(),
        '#url' => $revision
          ->toUrl('revision'),
        '#prefix' => '<div class="diff-revision__item diff-revision__item-date">',
        '#suffix' => '</div>',
      ];
    }
    return $revision_link;
  }

  /**
   * Build the filter navigation for the diff comparison.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The entity.
   * @param \Drupal\Core\Entity\ContentEntityInterface $left_revision
   *   Revision from the left side.
   * @param \Drupal\Core\Entity\ContentEntityInterface $right_revision
   *   Revision from the right side.
   * @param string $layout
   *   The layout plugin selected.
   * @param string $active_filter
   *   The active filter.
   *
   * @return array
   *   The filter options.
   */
  protected function buildFilterNavigation(ContentEntityInterface $entity, ContentEntityInterface $left_revision, ContentEntityInterface $right_revision, $layout, $active_filter) {

    // Build the view modes filter.
    $options['raw'] = [
      'title' => $this
        ->t('Raw'),
      'url' => PluginRevisionController::diffRoute($entity, $left_revision
        ->getRevisionId(), $right_revision
        ->getRevisionId(), $layout, [
        'filter' => 'raw',
      ]),
    ];
    $options['strip_tags'] = [
      'title' => $this
        ->t('Strip tags'),
      'url' => PluginRevisionController::diffRoute($entity, $left_revision
        ->getRevisionId(), $right_revision
        ->getRevisionId(), $layout, [
        'filter' => 'strip_tags',
      ]),
    ];
    $filter = $options[$active_filter];
    unset($options[$active_filter]);
    array_unshift($options, $filter);
    $build['options'] = [
      '#type' => 'operations',
      '#links' => $options,
    ];
    return $build;
  }

  /**
   * Applies a markdown function to a string.
   *
   * @param string $markdown
   *   Key of the markdown function to be applied to the items.
   *   One of drupal_html_to_text, filter_xss, filter_xss_all.
   * @param string $items
   *   String to be processed.
   *
   * @return array|string
   *   Result after markdown was applied on $items.
   */
  protected function applyMarkdown($markdown, $items) {
    if (!$markdown) {
      return $items;
    }
    if ($markdown == 'drupal_html_to_text') {
      return trim(MailFormatHelper::htmlToText($items), "\n");
    }
    elseif ($markdown == 'filter_xss') {
      return trim(Xss::filter($items), "\n");
    }
    elseif ($markdown == 'filter_xss_all') {
      return trim(Xss::filter($items, []), "\n");
    }
    else {
      return $items;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configFactory
      ->getEditable('diff.layout_plugins');
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $config = $this->configFactory
      ->getEditable('diff.layout_plugins');
    $config
      ->set($this->pluginId, $configuration);
    $config
      ->save();
  }

}

Members

Namesort descending 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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 3
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
DiffLayoutBase::__construct public function Constructs a DiffLayoutBase object. Overrides PluginBase::__construct 3
DiffLayoutInterface::build public function Builds a diff comparison between two revisions. 3
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.