class NameFieldBuilder in Name Field 8

Plugin to diff text fields.

Plugin annotation

@FieldDiffBuilder(
  id = "name_field_diff_builder",
  label = @Translation("Name Field"),
  field_types = {
    "name"
  },
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\diff\FieldDiffBuilderBase implements ContainerFactoryPluginInterface, FieldDiffBuilderInterface
      • class \Drupal\name\Plugin\diff\Field\NameFieldBuilder

File

src/Plugin/diff/Field/NameFieldBuilder.php, line 24

Namespace

Drupal\name\Plugin\diff\Field

class NameFieldBuilder extends FieldDiffBuilderBase {

  /**
   * The name formatter.
   *
   * @var \Drupal\name\NameFormatterInterface
   */
  protected $formatter;

  /**
   * Constructs a Name Field diff builder instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\diff\DiffEntityParser $entity_parser
   *   The entity parser.
   * @param \Drupal\name\NameFormatterInterface $formatter
   *   The name formatter.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, DiffEntityParser $entity_parser, NameFormatterInterface $formatter) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $entity_type_manager, $entity_parser);
    $this->formatter = $formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager'), $container
      ->get('diff.entity_parser'), $container
      ->get('name.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  public function build(FieldItemListInterface $items) {
    $result = [];
    if ($this->configuration['compare_format']) {
      foreach ($items as $item) {
        $result[] = (string) $this->formatter
          ->format($item
          ->filteredArray(), $this->configuration['compare_format']);
      }
    }
    else {
      foreach ($items as $item) {
        $output = [];
        $values = $item
          ->toArray();
        foreach ($item
          ->activeComponents() as $key => $label) {
          $output[] = "{$label}: {$values[$key]}";
        }
        $result[] = implode("\n", $output);
      }
    }
    return $result;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['compare_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Name format'),
      '#default_value' => $this->configuration['compare_format'],
      '#options' => name_get_custom_format_options(),
      '#empty_option' => $this
        ->t('-- components --'),
    ];
    return parent::buildConfigurationForm($form, $form_state);
  }

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

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $default_configuration = [
      'format' => '',
    ];
    $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::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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
NameFieldBuilder::$formatter	protected	property	The name formatter.
NameFieldBuilder::build	public	function	Builds an array of strings. Overrides FieldDiffBuilderInterface::build
NameFieldBuilder::buildConfigurationForm	public	function	Form constructor. Overrides FieldDiffBuilderBase::buildConfigurationForm
NameFieldBuilder::create	public static	function	Creates an instance of the plugin. Overrides FieldDiffBuilderBase::create
NameFieldBuilder::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides FieldDiffBuilderBase::defaultConfiguration
NameFieldBuilder::submitConfigurationForm	public	function	Form submission handler. Overrides FieldDiffBuilderBase::submitConfigurationForm
NameFieldBuilder::__construct	public	function	Constructs a Name Field diff builder instance. Overrides FieldDiffBuilderBase::__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.