public function FileFieldBuilder::build in Diff 8

Builds an array of strings.

This method is responsible for transforming a FieldItemListInterface object into an array of strings. The resulted array of strings is then compared by the Diff component with another such array of strings and the result represents the difference between two entity fields.

Example of FieldItemListInterface built into an array of strings:

array(
  0 => "This is an example string",
  1 => "Field values or properties",
);

Parameters

FieldItemListInterface $field_items: Represents an entity field.

Return value

mixed An array of strings to be compared. If an empty array is returned it means that a field is either empty or no properties need to be compared for that field.

Overrides FieldDiffBuilderInterface::build

File

src/Plugin/diff/Field/FileFieldBuilder.php, line 25

Class

FileFieldBuilder: Plugin to diff file fields.

Namespace

Drupal\diff\Plugin\diff\Field

Code

public function build(FieldItemListInterface $field_items) {
  $result = array();
  $fileManager = $this->entityTypeManager
    ->getStorage('file');

  // Every item from $field_items is of type FieldItemInterface.
  foreach ($field_items as $field_key => $field_item) {
    if (!$field_item
      ->isEmpty()) {
      $values = $field_item
        ->getValue();

      // Add file name to the comparison.
      if (isset($values['target_id'])) {

        /** @var \Drupal\file\Entity\File $file */
        $file = $fileManager
          ->load($values['target_id']);
        $result[$field_key][] = $this
          ->t('File: :image', [
          ':image' => $file
            ->getFilename(),
        ]);
      }

      // Add file id to the comparison.
      if ($this->configuration['show_id']) {
        if (isset($values['target_id'])) {
          $result[$field_key][] = $this
            ->t('File ID: :fid', [
            ':fid' => $values['target_id'],
          ]);
        }
      }

      // Compare file description fields.
      if ($this->configuration['compare_description_field']) {
        if (isset($values['description'])) {
          $result[$field_key][] = $this
            ->t('Description: @description', [
            '@description' => $values['description'],
          ]);
        }
      }

      // Compare Enable Display property.
      if ($this->configuration['compare_display_field']) {
        if (isset($values['display'])) {
          if ($values['display'] == 1) {
            $result[$field_key][] = $this
              ->t('Displayed');
          }
          else {
            $result[$field_key][] = $this
              ->t('Hidden');
          }
        }
      }

      // Add the requested separator between resulted strings.
      if ($this->configuration['property_separator']) {
        $separator = $this->configuration['property_separator'] == 'nl' ? "\n" : $this->configuration['property_separator'];
        $result[$field_key] = implode($separator, $result[$field_key]);
      }
    }
  }
  return $result;
}

You are here