class CommentFieldDiffParser in Entity Share 8.3

Plugin to diff comment fields.

Plugin annotation

@DiffGenerator(
  id = "comment_field_diff_parser",
  label = @Translation("Comment Field Diff Parser"),
  field_types = {
    "comment"
  },
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\entity_share_diff\DiffGenerator\DiffGeneratorPluginBase implements ContainerFactoryPluginInterface, DiffGeneratorInterface uses StringTranslationTrait
    • class \Drupal\entity_share_diff\Plugin\DiffGenerator\CommentFieldDiffParser

File

modules/entity_share_diff/src/Plugin/DiffGenerator/CommentFieldDiffParser.php, line 22

Namespace

Drupal\entity_share_diff\Plugin\DiffGenerator

class CommentFieldDiffParser extends DiffGeneratorPluginBase {

  /**
   * {@inheritdoc}
   */
  public function build(FieldItemListInterface $field_items, array $remote_field_data = []) {
    $result = [];

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
CommentFieldDiffParser::build	public	function	Builds an array of strings. Overrides DiffGeneratorInterface::build
DiffGeneratorPluginBase::$entityParser	protected	property	The entity parser service.
DiffGeneratorPluginBase::$entityTypeManager	protected	property	The entity type manager.
DiffGeneratorPluginBase::$remote	protected	property	The 'Remote' entity.
DiffGeneratorPluginBase::$remoteManager	protected	property	The remote manager service.
DiffGeneratorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
DiffGeneratorPluginBase::getRemote	public	function	Returns Remote entity.
DiffGeneratorPluginBase::isApplicable	public static	function	Returns if the plugin can be used for the provided field. Overrides DiffGeneratorInterface::isApplicable
DiffGeneratorPluginBase::setRemote	public	function	Sets Remote entity.
DiffGeneratorPluginBase::__construct	public	function	Constructs a DiffManagerBase object. Overrides PluginBase::__construct
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.