public function SplitFieldsDiffLayout::build in Diff 8

Builds a diff comparison between two revisions.

This method is responsible for building the diff comparison between revisions of the same entity. It can build a table, navigation links and headers of a diff comparison.

Parameters

\Drupal\Core\Entity\ContentEntityInterface $left_revision: The left revision.

\Drupal\Core\Entity\ContentEntityInterface $right_revision: The right revision.

\Drupal\Core\Entity\ContentEntityInterface $entity: The entity.

Return value

array The modified build array that the plugin builds.

Overrides DiffLayoutInterface::build

File

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

Class

SplitFieldsDiffLayout

Provides Split fields diff layout.

Namespace

Drupal\diff\Plugin\diff\Layout

Code

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;
}