public function CommentFieldBuilder::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

See also

\Drupal\diff\Plugin\diff\Field\TextFieldBuilder

File

src/Plugin/diff/Field/CommentFieldBuilder.php, line 26

Class

CommentFieldBuilder

Plugin to diff comment fields.

Namespace

Drupal\diff\Plugin\diff\Field

Code

public function build(FieldItemListInterface $field_items) {
  $result = array();

  // 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();

      // Compare the key of the comment status.
      if ($this->configuration['compare_key']) {
        if (isset($values['status'])) {
          $result[$field_key][] = $values['status'];
        }
      }

      // A more human friendly representation.
      if ($this->configuration['compare_string']) {
        if (isset($values['status'])) {
          switch ($values['status']) {
            case CommentItemInterface::OPEN:
              $result[$field_key][] = $this
                ->t('Comments for this entity are open.');
              break;
            case CommentItemInterface::CLOSED:
              $result[$field_key][] = $this
                ->t('Comments for this entity are closed.');
              break;
            case CommentItemInterface::HIDDEN:
              $result[$field_key][] = $this
                ->t('Comments for this entity are hidden.');
              break;
          }
        }
      }
    }
  }
  return $result;
}