class SplitFieldsDiffLayout in Diff 8

Provides Split fields diff layout.

Plugin annotation


@DiffLayoutBuilder(
  id = "split_fields",
  label = @Translation("Split fields"),
  description = @Translation("Field based layout, displays revision comparison side by side."),
)

Hierarchy

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

Expanded class hierarchy of SplitFieldsDiffLayout

File

src/Plugin/diff/Layout/SplitFieldsDiffLayout.php, line 25

Namespace

Drupal\diff\Plugin\diff\Layout

View source

class SplitFieldsDiffLayout extends DiffLayoutBase {

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

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

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

  /**
   * Constructs a SplitFieldsDiffLayout 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 \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  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, RequestStack $request_stack) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config, $entity_type_manager, $entity_parser, $date);
    $this->renderer = $renderer;
    $this->entityComparison = $entity_comparison;
    $this->requestStack = $request_stack;
  }

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

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

    // Build the revisions data.
    $build = $this
      ->buildRevisionsData($left_revision, $right_revision);
    $active_filter = $this->requestStack
      ->getCurrentRequest()->query
      ->get('filter') ?: 'raw';
    $build['controls']['filter'] = [
      '#type' => 'item',
      '#title' => $this
        ->t('Filter'),
      '#wrapper_attributes' => [
        'class' => 'diff-controls__item',
      ],
      'options' => $this
        ->buildFilterNavigation($entity, $left_revision, $right_revision, 'split_fields', $active_filter),
    ];

    // Build the diff comparison table.
    $diff_header = $this
      ->buildTableHeader($left_revision, $right_revision);

    // Perform comparison only if both entity revisions loaded successfully.
    $fields = $this->entityComparison
      ->compareRevisions($left_revision, $right_revision);

    // Build the diff rows for each field and append the field rows
    // to the table rows.
    $diff_rows = [];
    $raw_active = $active_filter == 'raw';
    foreach ($fields as $field) {
      $field_label_row = '';
      if (!empty($field['#name'])) {
        $field_label_row = [
          'data' => $field['#name'],
          'colspan' => 8,
          'class' => [
            'field-name',
          ],
        ];
      }
      if (!$raw_active) {
        $field_settings = $field['#settings'];
        if (!empty($field_settings['settings']['markdown'])) {
          $field['#data']['#left'] = $this
            ->applyMarkdown($field_settings['settings']['markdown'], $field['#data']['#left']);
          $field['#data']['#right'] = $this
            ->applyMarkdown($field_settings['settings']['markdown'], $field['#data']['#right']);
        }
        else {
          $field['#data']['#left'] = $this
            ->applyMarkdown('drupal_html_to_text', $field['#data']['#left']);
          $field['#data']['#right'] = $this
            ->applyMarkdown('drupal_html_to_text', $field['#data']['#right']);
        }
      }

      // Process the array (split the strings into single line strings)
      // and get line counts per field.
      $this->entityComparison
        ->processStateLine($field);
      $field_diff_rows = $this->entityComparison
        ->getRows($field['#data']['#left'], $field['#data']['#right']);

      // EXPERIMENTAL: Deal with magic thumbnail image data.
      if (isset($field['#data']['#left_thumbnail'])) {
        $field_diff_rows['#thumbnail'][1] = [
          'data' => $field['#data']['#left_thumbnail'],
          'class' => '',
        ];
      }
      if (isset($field['#data']['#right_thumbnail'])) {
        $field_diff_rows['#thumbnail'][3] = [
          'data' => $field['#data']['#right_thumbnail'],
          'class' => '',
        ];
      }
      $final_diff = [];
      $row_count_left = NULL;
      $row_count_right = NULL;
      foreach ($field_diff_rows as $key => $value) {
        $show_left = FALSE;
        $show_right = FALSE;
        if (isset($field_diff_rows[$key][1]['data'])) {
          $show_left = TRUE;
          $row_count_left++;
        }
        if (isset($field_diff_rows[$key][3]['data'])) {
          $show_right = TRUE;
          $row_count_right++;
        }
        $final_diff[] = [
          'left-line-number' => [
            'data' => $show_left ? $row_count_left : NULL,
            'class' => [
              'diff-line-number',
              isset($field_diff_rows[$key][1]['data']) ? $field_diff_rows[$key][1]['class'] : NULL,
            ],
          ],
          'left-row-sign' => [
            'data' => isset($field_diff_rows[$key][0]['data']) ? $field_diff_rows[$key][0]['data'] : NULL,
            'class' => [
              isset($field_diff_rows[$key][0]['class']) ? $field_diff_rows[$key][0]['class'] : NULL,
              isset($field_diff_rows[$key][1]['data']) ? $field_diff_rows[$key][1]['class'] : NULL,
            ],
          ],
          'left-row-data' => [
            'data' => isset($field_diff_rows[$key][1]['data']) ? $field_diff_rows[$key][1]['data'] : NULL,
            'class' => isset($field_diff_rows[$key][1]['data']) ? $field_diff_rows[$key][1]['class'] : NULL,
          ],
          'right-line-number' => [
            'data' => $show_right ? $row_count_right : NULL,
            'class' => [
              'diff-line-number',
              isset($field_diff_rows[$key][3]['data']) ? $field_diff_rows[$key][3]['class'] : NULL,
            ],
          ],
          'right-row-sign' => [
            'data' => isset($field_diff_rows[$key][2]['data']) ? $field_diff_rows[$key][2]['data'] : NULL,
            'class' => [
              isset($field_diff_rows[$key][2]['class']) ? $field_diff_rows[$key][2]['class'] : NULL,
              isset($field_diff_rows[$key][3]['data']) ? $field_diff_rows[$key][3]['class'] : NULL,
            ],
          ],
          'right-row-data' => [
            'data' => isset($field_diff_rows[$key][3]['data']) ? $field_diff_rows[$key][3]['data'] : NULL,
            'class' => isset($field_diff_rows[$key][3]['data']) ? $field_diff_rows[$key][3]['class'] : NULL,
          ],
        ];
      }

      // Add field label to the table only if there are changes to that field.
      if (!empty($final_diff) && !empty($field_label_row)) {
        $diff_rows[] = [
          $field_label_row,
        ];
      }

      // Add field diff rows to the table rows.
      $diff_rows = array_merge($diff_rows, $final_diff);
    }
    if (!$raw_active) {

      // Remove line numbers.
      foreach ($diff_rows as $i => $row) {
        unset($diff_rows[$i]['left-line-number']);
        unset($diff_rows[$i]['right-line-number']);
      }

      // Reduce the colspan.
      $diff_header[0]['colspan'] = 2;
    }
    $build['diff'] = [
      '#type' => 'table',
      '#header' => $diff_header,
      '#rows' => $diff_rows,
      '#weight' => 10,
      '#empty' => $this
        ->t('No visible changes'),
      '#attributes' => [
        'class' => [
          'diff',
        ],
      ],
    ];
    $build['#attached']['library'][] = 'diff/diff.double_column';
    $build['#attached']['library'][] = 'diff/diff.colors';
    return $build;
  }

  /**
   * Build the header for the diff table.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $left_revision
   *   Revision from the left hand side.
   * @param \Drupal\Core\Entity\ContentEntityInterface $right_revision
   *   Revision from the right hand side.
   *
   * @return array
   *   Header for Diff table.
   */
  protected function buildTableHeader(ContentEntityInterface $left_revision, ContentEntityInterface $right_revision) {
    $header = [];
    $header[] = [
      'data' => [
        '#markup' => $this
          ->buildRevisionLink($left_revision),
      ],
      'colspan' => 3,
    ];
    $header[] = [
      'data' => [
        '#markup' => $this
          ->buildRevisionLink($right_revision),
      ],
      'colspan' => 3,
    ];
    return $header;
  }

}

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.
SplitFieldsDiffLayout::$entityComparison	protected	property	The diff entity comparison service.
SplitFieldsDiffLayout::$renderer	protected	property	The renderer.
SplitFieldsDiffLayout::$requestStack	protected	property	The request stack.
SplitFieldsDiffLayout::build	public	function	Builds a diff comparison between two revisions. Overrides DiffLayoutInterface::build
SplitFieldsDiffLayout::buildTableHeader	protected	function	Build the header for the diff table.
SplitFieldsDiffLayout::create	public static	function	Creates an instance of the plugin. Overrides DiffLayoutBase::create
SplitFieldsDiffLayout::__construct	public	function	Constructs a SplitFieldsDiffLayout object. Overrides DiffLayoutBase::__construct
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.

You are here

class SplitFieldsDiffLayout in Diff 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation