You are here

class TestHeavierTextPlugin in Diff 8

Test diff builder with heavy weight.

Plugin annotation


@FieldDiffBuilder(
  id = "test_heavier_text_plugin",
  label = @Translation("Test Heavier Text Plugin"),
  field_types = {
    "text",
  },
  weight = -10,
)

Hierarchy

Expanded class hierarchy of TestHeavierTextPlugin

File

tests/modules/diff_test/src/Plugin/diff/Field/TestHeavierTextPlugin.php, line 21

Namespace

Drupal\diff_test\Plugin\diff\Field
View source
class TestHeavierTextPlugin extends FieldDiffBuilderBase {

  /**
   * {@inheritdoc}
   */
  public function build(FieldItemListInterface $field_items) {
    $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();
        if (isset($values['value'])) {
          $result[$field_key][] = str_replace('applicable', 'heavier_test_plugin', $values['value']);
        }
      }
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldStorageDefinitionInterface $field_definition) {
    return $field_definition
      ->getName() == 'test_field' || $field_definition
      ->getName() == 'test_field_lighter';
  }

}

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::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 8
FieldDiffBuilderBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
FieldDiffBuilderBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 8
FieldDiffBuilderBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldDiffBuilderBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldDiffBuilderBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 8
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.
TestHeavierTextPlugin::build public function Builds an array of strings. Overrides FieldDiffBuilderInterface::build
TestHeavierTextPlugin::isApplicable public static function Returns if the plugin can be used for the provided field. Overrides FieldDiffBuilderBase::isApplicable