You are here

Home » API reference » Range 8 » RangeField.php

class RangeField in Range 8

Same name in this branch
  1. 8 src/Plugin/migrate/process/d6/RangeField.php \Drupal\range\Plugin\migrate\process\d6\RangeField
  2. 8 src/Plugin/migrate/field/d6/RangeField.php \Drupal\range\Plugin\migrate\field\d6\RangeField
  3. 8 src/Plugin/migrate/field/d7/RangeField.php \Drupal\range\Plugin\migrate\field\d7\RangeField

MigrateField Plugin for Drupal 6 range fields.

Plugin annotation


@MigrateField(
  id = "d6_range",
  core = {6},
  type_map = {
    "range_decimal" = "range_decimal",
    "range_float" = "range_float",
    "range_integer" = "range_integer",
  },
  source_module = "range",
  destination_module = "range"
)

Hierarchy

Expanded class hierarchy of RangeField

1 file declares its use of RangeField
RangeFieldTest.php in tests/src/Unit/Plugin/migrate/field/d6/RangeFieldTest.php

File

src/Plugin/migrate/field/d6/RangeField.php, line 23

Namespace

Drupal\range\Plugin\migrate\field\d6
View source 
class RangeField extends FieldPluginBase {

  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    return [
      'range' => 'range',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldMigration(MigrationInterface $migration) {

    /** @var \Drupal\migrate\Row $row */
    $row = $migration
      ->getSourcePlugin()
      ->current();
    if ($this
      ->isRangeField($row
      ->getSourceProperty('type'))) {
      $process_type = [];
      $process_type[0]['map'] = [
        'range_decimal' => [
          'range' => 'range_decimal',
        ],
        'range_float' => [
          'range' => 'range_float',
        ],
        'range_integer' => [
          'range' => 'range_integer',
        ],
      ];
      $migration
        ->mergeProcessOfProperty('type', $process_type);
      $process_settings = [
        'plugin' => 'd6_range_field_settings',
      ];
      $migration
        ->mergeProcessOfProperty('settings', $process_settings);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldInstanceMigration(MigrationInterface $migration) {

    /** @var \Drupal\migrate\Row $row */
    $row = $migration
      ->getSourcePlugin()
      ->current();
    if ($this
      ->isRangeField($row
      ->getSourceProperty('type'))) {
      $process_settings = [
        'plugin' => 'd6_range_field_instance_settings',
      ];
      $migration
        ->mergeProcessOfProperty('settings', $process_settings);
      $process_defaults = [
        'plugin' => 'd6_range_field_instance_defaults',
      ];
      $migration
        ->mergeProcessOfProperty('default_value', $process_defaults);
    }
    parent::alterFieldInstanceMigration($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldFormatterMigration(MigrationInterface $migration) {

    /** @var \Drupal\migrate\Row $row */
    $row = $migration
      ->getSourcePlugin()
      ->current();
    if ($this
      ->isRangeField($row
      ->getSourceProperty('type'))) {
      $process_type = [];
      $process_type[0]['map']['range_decimal'] = $process_type[0]['map']['range_float'] = [
        'default' => 'range_decimal',
        'us_0' => 'range_decimal',
        'us_1' => 'range_decimal',
        'us_2' => 'range_decimal',
        'be_0' => 'range_decimal',
        'be_1' => 'range_decimal',
        'be_2' => 'range_decimal',
        'fr_0' => 'range_decimal',
        'fr_1' => 'range_decimal',
        'fr_2' => 'range_decimal',
        'unformatted' => 'range_unformatted',
      ];
      $process_type[0]['map']['range_integer'] = [
        'default' => 'range_integer',
        'us_0' => 'range_integer',
        'be_0' => 'range_integer',
        'fr_0' => 'range_integer',
        'unformatted' => 'range_unformatted',
      ];
      $migration
        ->mergeProcessOfProperty('options/type', $process_type);
      $process_settings = [
        'plugin' => 'd6_range_field_formatter_settings',
      ];
      $migration
        ->mergeProcessOfProperty('options/settings', $process_settings);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $process = [
      'plugin' => 'd6_range_field',
      'source' => $field_name,
    ];
    $migration
      ->mergeProcessOfProperty($field_name, $process);
  }

  /**
   * Checks whether the given field type is a range field.
   *
   * This plugin is being called for every single field type existing in the
   * source database.
   *
   * @param string $type
   *   Field type that is being migrated.
   *
   * @return bool
   *   TRUE if the given field type is a range field, FALSE otherwise.
   */
  private function isRangeField($type) {
    return array_key_exists($type, $this->pluginDefinition['type_map']);
  }

}

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
FieldPluginBase::alterFieldWidgetMigration public function Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterMap public function Get a map between D6 formatters and D8 formatters for this field type. Overrides MigrateFieldInterface::getFieldFormatterMap 12
FieldPluginBase::getFieldFormatterType public function Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType 1
FieldPluginBase::getFieldType public function Computes the destination type of a migrated field. Overrides MigrateFieldInterface::getFieldType 6
FieldPluginBase::getFieldWidgetType public function Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType 1
FieldPluginBase::processField Deprecated public function Alters the migration for field definitions.
FieldPluginBase::processFieldFormatter Deprecated public function Alter field formatter migration.
FieldPluginBase::processFieldInstance Deprecated public function Alert field instance migration.
FieldPluginBase::processFieldValues Deprecated public function Defines the process pipeline for field values.
FieldPluginBase::processFieldWidget Deprecated public function Alter field widget migration.
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
RangeField::alterFieldFormatterMigration public function Apply any custom processing to the field formatter migration. Overrides FieldPluginBase::alterFieldFormatterMigration
RangeField::alterFieldInstanceMigration public function Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
RangeField::alterFieldMigration public function Apply any custom processing to the field migration. Overrides FieldPluginBase::alterFieldMigration
RangeField::defineValueProcessPipeline public function Apply any custom processing to the field bundle migrations. Overrides FieldPluginBase::defineValueProcessPipeline
RangeField::getFieldWidgetMap public function Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
RangeField::isRangeField private function Checks whether the given field type is a range field.
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.