class FieldFormatterSettingsDefaults in Drupal 8

Set the default field settings.

Plugin annotation

@MigrateProcessPlugin(
  id = "field_formatter_settings_defaults"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\field\Plugin\migrate\process\d6\FieldFormatterSettingsDefaults

File

core/modules/field/src/Plugin/migrate/process/d6/FieldFormatterSettingsDefaults.php, line 16

Namespace

Drupal\field\Plugin\migrate\process\d6

class FieldFormatterSettingsDefaults extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   *
   * Set field formatter settings when the map didn't map: for date
   * formatters, the fallback format, for everything else, empty array.
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {

    // If the 1 index is set then the map missed.
    if (isset($value[1])) {
      $module = $row
        ->getSourceProperty('module');
      if ($module === 'date') {
        $value = [
          'format_type' => 'fallback',
        ];
      }
      elseif ($module === 'number') {

        // We have to do the lookup here in the process plugin because for
        // number we need to calculated the settings based on the type not just
        // the module which works well for other field types.
        return $this
          ->numberSettings($row
          ->getDestinationProperty('options/type'), $value[1]);
      }
      else {
        $value = [];
      }
    }
    return $value;
  }

  /**
   * @param string $type
   *   The field type.
   * @param $format
   *   The format selected for the field on the display.
   *
   * @return array
   *   The correct default settings.
   *
   * @throws \Drupal\migrate\MigrateException
   */
  protected function numberSettings($type, $format) {
    $map = [
      'number_decimal' => [
        'us_0' => [
          'scale' => 0,
          'decimal_separator' => '.',
          'thousand_separator' => ',',
          'prefix_suffix' => TRUE,
        ],
        'us_1' => [
          'scale' => 1,
          'decimal_separator' => '.',
          'thousand_separator' => ',',
          'prefix_suffix' => TRUE,
        ],
        'us_2' => [
          'scale' => 2,
          'decimal_separator' => '.',
          'thousand_separator' => ',',
          'prefix_suffix' => TRUE,
        ],
        'be_0' => [
          'scale' => 0,
          'decimal_separator' => ',',
          'thousand_separator' => '.',
          'prefix_suffix' => TRUE,
        ],
        'be_1' => [
          'scale' => 1,
          'decimal_separator' => ',',
          'thousand_separator' => '.',
          'prefix_suffix' => TRUE,
        ],
        'be_2' => [
          'scale' => 2,
          'decimal_separator' => ',',
          'thousand_separator' => '.',
          'prefix_suffix' => TRUE,
        ],
        'fr_0' => [
          'scale' => 0,
          'decimal_separator' => ',',
          'thousand_separator' => ' ',
          'prefix_suffix' => TRUE,
        ],
        'fr_1' => [
          'scale' => 1,
          'decimal_separator' => ',',
          'thousand_separator' => ' ',
          'prefix_suffix' => TRUE,
        ],
        'fr_2' => [
          'scale' => 2,
          'decimal_separator' => ',',
          'thousand_separator' => ' ',
          'prefix_suffix' => TRUE,
        ],
      ],
      'number_integer' => [
        'us_0' => [
          'thousand_separator' => ',',
          'prefix_suffix' => TRUE,
        ],
        'be_0' => [
          'thousand_separator' => '.',
          'prefix_suffix' => TRUE,
        ],
        'fr_0' => [
          'thousand_separator' => ' ',
          'prefix_suffix' => TRUE,
        ],
      ],
    ];
    return isset($map[$type][$format]) ? $map[$type][$format] : [];
  }

}

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
FieldFormatterSettingsDefaults::numberSettings	protected	function
FieldFormatterSettingsDefaults::transform	public	function	Set field formatter settings when the map didn't map: for date formatters, the fallback format, for everything else, empty array. Overrides ProcessPluginBase::transform
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
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.