abstract class CckFieldPluginBase in Zircon Profile 8

The base class for all cck field plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate_drupal\Plugin\migrate\cckfield\CckFieldPluginBase implements MigrateCckFieldInterface

See also

\Drupal\migrate_drupal\Plugin\MigratePluginManager

\Drupal\migrate_drupal\Annotation\MigrateCckField

\Drupal\migrate_drupal\Plugin\MigrateCckFieldInterface

Plugin API

Related topics

Migration API

Overview of the Migration API, which migrates data into Drupal.

4 files declare their use of CckFieldPluginBase

FileField.php in core/modules/file/src/Plugin/migrate/cckfield/FileField.php

Contains \Drupal\file\Plugin\migrate\cckfield\FileField.

LinkField.php in core/modules/link/src/Plugin/migrate/cckfield/LinkField.php

Contains \Drupal\link\Plugin\migrate\cckfield\LinkField.

TaxonomyTermReference.php in core/modules/taxonomy/src/Plugin/migrate/cckfield/TaxonomyTermReference.php

Contains \Drupal\taxonomy\Plugin\migrate\cckfield\TaxonomyTermReference.

TextField.php in core/modules/text/src/Plugin/migrate/cckfield/TextField.php

Contains \Drupal\text\Plugin\migrate\cckfield\TextField.

File

core/modules/migrate_drupal/src/Plugin/migrate/cckfield/CckFieldPluginBase.php, line 25

Contains \Drupal\migrate_drupal\Plugin\migrate\cckfield\CckFieldPluginBase.

Namespace

Drupal\migrate_drupal\Plugin\migrate\cckfield

abstract class CckFieldPluginBase extends PluginBase implements MigrateCckFieldInterface {

  /**
   * {@inheritdoc}
   */
  public function processField(MigrationInterface $migration) {
    $process[0]['map'][$this->pluginId][$this->pluginId] = $this->pluginId;
    $migration
      ->mergeProcessOfProperty('type', $process);
  }

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

    // Nothing to do by default with field instances.
  }

  /**
   * {@inheritdoc}
   */
  public function processFieldWidget(MigrationInterface $migration) {
    $process = [];
    foreach ($this
      ->getFieldWidgetMap() as $source_widget => $destination_widget) {
      $process['type']['map'][$source_widget] = $destination_widget;
    }
    $migration
      ->mergeProcessOfProperty('options/type', $process);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {

    // By default use the plugin id for the widget types.
    return [
      $this->pluginId => $this->pluginId . '_default',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function processFieldFormatter(MigrationInterface $migration) {
    $process = [];
    foreach ($this
      ->getFieldFormatterMap() as $source_format => $destination_format) {
      $process[0]['map'][$this->pluginId][$source_format] = $destination_format;
    }
    $migration
      ->mergeProcessOfProperty('options/type', $process);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldType(Row $row) {
    $field_type = $row
      ->getSourceProperty('type');
    if (isset($this->pluginDefinition['type_map'][$field_type])) {
      return $this->pluginDefinition['type_map'][$field_type];
    }
    else {
      return $field_type;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CckFieldPluginBase::getFieldType	public	function	Computes the destination type of a migrated field. Overrides MigrateCckFieldInterface::getFieldType	2
CckFieldPluginBase::getFieldWidgetMap	public	function	Get a map between D6 and D8 widgets for this field type. Overrides MigrateCckFieldInterface::getFieldWidgetMap	2
CckFieldPluginBase::processField	public	function	Apply any custom processing to the field migration. Overrides MigrateCckFieldInterface::processField
CckFieldPluginBase::processFieldFormatter	public	function	Apply any custom processing to the field formatter migration. Overrides MigrateCckFieldInterface::processFieldFormatter
CckFieldPluginBase::processFieldInstance	public	function	Apply any custom processing to the field instance migration. Overrides MigrateCckFieldInterface::processFieldInstance
CckFieldPluginBase::processFieldWidget	public	function	Apply any custom processing to the field widget migration. Overrides MigrateCckFieldInterface::processFieldWidget
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
MigrateCckFieldInterface::getFieldFormatterMap	public	function	Get a map between D6 formatters and D8 formatters for this field type.	4
MigrateCckFieldInterface::processCckFieldValues	public	function	Apply any custom processing to the cck bundle migrations.	4
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.