You are here

class CommentFieldBuilder in Diff 8

Plugin to diff comment fields.

Plugin annotation


@FieldDiffBuilder(
  id = "comment_field_diff_builder",
  label = @Translation("Comment Field Diff"),
  field_types = {
    "comment"
  },
)

Hierarchy

Expanded class hierarchy of CommentFieldBuilder

File

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

Namespace

Drupal\diff\Plugin\diff\Field
View source
class CommentFieldBuilder 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) {
      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;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['compare_key'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare comment status key'),
      '#default_value' => $this->configuration['compare_key'],
    );
    $form['compare_string'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Compare comment status string'),
      '#default_value' => $this->configuration['compare_string'],
    );
    return parent::buildConfigurationForm($form, $form_state);
  }

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

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

}

Members

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