You are here

Home » API reference » Diff 8 » FileFieldBuilder.php

class FileFieldBuilder in Diff 8

Plugin to diff file fields.

Plugin annotation


@FieldDiffBuilder(
  id = "file_field_diff_builder",
  label = @Translation("File Field Diff"),
  field_types = {
    "file"
  },
)

Hierarchy

Expanded class hierarchy of FileFieldBuilder

File

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

Namespace

Drupal\diff\Plugin\diff\Field
View source 
class FileFieldBuilder extends FieldDiffBuilderBase {

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['show_id'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show file ID'),
      '#default_value' => $this->configuration['show_id'],
    );
    $form['compare_description_field'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare description field'),
      '#default_value' => $this->configuration['compare_description_field'],
      '#description' => $this
        ->t('This is only used if the "Enable <em>Description</em> field" is checked in the instance settings.'),
    );
    $form['compare_display_field'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare display state field'),
      '#default_value' => $this->configuration['compare_display_field'],
      '#description' => $this
        ->t('This is only used if the "Enable <em>Display</em> field" is checked in the field settings.'),
    );
    $form['property_separator'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Property separator'),
      '#default_value' => $this->configuration['property_separator'],
      '#description' => $this
        ->t('Provides the ability to show properties inline or across multiple lines.'),
      '#options' => array(
        ', ' => $this
          ->t('Comma (,)'),
        '; ' => $this
          ->t('Semicolon (;)'),
        ' ' => $this
          ->t('Space'),
        'nl' => $this
          ->t('New line'),
      ),
    );
    return parent::buildConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['show_id'] = $form_state
      ->getValue('show_id');
    $this->configuration['compare_description_field'] = $form_state
      ->getValue('compare_description_field');
    $this->configuration['compare_display_field'] = $form_state
      ->getValue('compare_display_field');
    $this->configuration['property_separator'] = $form_state
      ->getValue('property_separator');
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default_configuration = array(
      'show_id' => 1,
      'compare_description_field' => 0,
      'compare_display_field' => 0,
      'property_separator' => 'nl',
    );
    $default_configuration += parent::defaultConfiguration();
    return $default_configuration;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldDiffBuilderBase::$configFactory protected property Contains the configuration object factory.
FieldDiffBuilderBase::$entityParser protected property The entity parser.
FieldDiffBuilderBase::$entityTypeManager protected property The entity type manager.
FieldDiffBuilderBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
FieldDiffBuilderBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldDiffBuilderBase::isApplicable public static function Returns if the plugin can be used for the provided field. Overrides FieldDiffBuilderInterface::isApplicable 2
FieldDiffBuilderBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldDiffBuilderBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
FieldDiffBuilderBase::__construct public function Constructs a FieldDiffBuilderBase object. Overrides PluginBase::__construct 1
FileFieldBuilder::build public function Builds an array of strings. Overrides FieldDiffBuilderInterface::build
FileFieldBuilder::buildConfigurationForm public function Form constructor. Overrides FieldDiffBuilderBase::buildConfigurationForm
FileFieldBuilder::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldDiffBuilderBase::defaultConfiguration
FileFieldBuilder::submitConfigurationForm public function Form submission handler. Overrides FieldDiffBuilderBase::submitConfigurationForm
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.