class TextWithSummaryFieldBuilder in Diff 8

Plugin to diff text with summary fields.

Plugin annotation


@FieldDiffBuilder(
  id = "text_summary_field_diff_builder",
  label = @Translation("Text with Summary Field"),
  field_types = {
    "text_with_summary"
  },
)

View source

class TextWithSummaryFieldBuilder extends FieldDiffBuilderBase {

  /**
   * {@inheritdoc}
   */
  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) {
      $values = $field_item
        ->getValue();

      // Compare text formats.
      if ($this->configuration['compare_format'] == 1) {
        if (isset($values['format'])) {
          $controller = $this->entityTypeManager
            ->getStorage('filter_format');
          $format = $controller
            ->load($values['format']);

          // The format loaded successfully.
          $label = $this
            ->t('Format');
          if ($format != NULL) {
            $result[$field_key][] = $label . ": " . $format->name;
          }
          else {
            $result[$field_key][] = $label . ": " . $this
              ->t('Missing format @format', array(
              '@format' => $values[$field_key],
            ));
          }
        }
      }

      // Handle the text summary.
      if ($this->configuration['compare_summary'] == 1) {
        if (isset($values['summary'])) {
          $label = $this
            ->t('Summary');
          if ($values['summary'] == '') {
            $result[$field_key][] = $label . ":\n" . $this
              ->t('Empty');
          }
          else {
            $result[$field_key][] = $label . ":\n" . $values['summary'];
          }
        }
      }

      // Compare field values.
      if (isset($values['value'])) {
        $value_only = TRUE;

        // Check if summary or text format are included in the diff.
        if ($this->configuration['compare_format'] == 1 || $this->configuration['compare_summary'] == 1) {
          $value_only = FALSE;
        }
        $label = $this
          ->t('Value');
        if ($value_only) {

          // Don't display 'value' label.
          $result[$field_key][] = $values['value'];
        }
        else {
          $result[$field_key][] = $label . ":\n" . $values['value'];
        }
      }
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['compare_format'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare format'),
      '#default_value' => $this->configuration['compare_format'],
      '#description' => $this
        ->t('This is only used if the "Text processing" instance settings are set to <em>Filtered text (user selects text format)</em>.'),
    );
    $form['compare_summary'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare summary separately'),
      '#default_value' => $this->configuration['compare_summary'],
      '#description' => $this
        ->t('This is only used if the "Summary input" option is checked in the instance settings.'),
    );
    return parent::buildConfigurationForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default_configuration = array(
      'compare_format' => 0,
      'compare_summary' => 0,
    );
    $default_configuration += parent::defaultConfiguration();
    return $default_configuration;
  }

}

Members

Name	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
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.
TextWithSummaryFieldBuilder::build	public	function	Builds an array of strings. Overrides FieldDiffBuilderInterface::build
TextWithSummaryFieldBuilder::buildConfigurationForm	public	function	Form constructor. Overrides FieldDiffBuilderBase::buildConfigurationForm
TextWithSummaryFieldBuilder::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FieldDiffBuilderBase::defaultConfiguration
TextWithSummaryFieldBuilder::submitConfigurationForm	public	function	Form submission handler. Overrides FieldDiffBuilderBase::submitConfigurationForm

You are here

class TextWithSummaryFieldBuilder in Diff 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation