1. class
  2. Drupal
  3. \
  4. options
  5. \
  6. Plugin
  7. \
  8. migrate
  9. \
  10. field
  11. \
  12. d7
  13. \
  14. OptionsField

OptionsField

class OptionsField extends FieldPluginBase (View source)

Traits

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

MessengerTrait

Provides a trait for the messenger service.

Constants

DERIVATIVE_SEPARATOR

A string which is used to separate base plugin IDs from the derivative ID.

Properties

protected string $pluginId

The plugin_id.

 from  PluginBase
protected array $pluginDefinition

The plugin implementation definition.

 from  PluginBase
protected array $configuration

Configuration information passed into the plugin.

 from  PluginBase
protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected array $_serviceIds

An array of service IDs keyed by property name used for serialization.

 from  DependencySerializationTrait
protected array $_entityStorages

An array of entity type IDs keyed by the property name of their storages.

 from  DependencySerializationTrait
protected MessengerInterface $messenger

The messenger.

 from  MessengerTrait

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a \Drupal\Component\Plugin\PluginBase object.

from  PluginBase
string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginBase
string
getBaseId()

Gets the base_plugin_id of the plugin instance.

from  PluginBase
string|null
getDerivativeId()

Gets the derivative_id of the plugin instance.

from  PluginBase
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__sleep()

{@inheritdoc}

from  DependencySerializationTrait
__wakeup()

{@inheritdoc}

from  DependencySerializationTrait
setMessenger(MessengerInterface $messenger)

Sets the messenger.

from  MessengerTrait
MessengerInterface
messenger()

Gets the messenger.

from  MessengerTrait
alterFieldMigration(MigrationInterface $migration)

Apply any custom processing to the field migration.

from  FieldPluginBase
alterFieldInstanceMigration(MigrationInterface $migration)

Apply any custom processing to the field instance migration.

from  FieldPluginBase
alterFieldWidgetMigration(MigrationInterface $migration)

Apply any custom processing to the field widget migration.

from  FieldPluginBase
string
getFieldFormatterType(Row $row)

Get the field formatter type from the source.

from  FieldPluginBase
array
getFieldFormatterMap()

Get a map between D6 formatters and D8 formatters for this field type.

from  FieldPluginBase
string
getFieldWidgetType(Row $row)

Get the field widget type from the source.

from  FieldPluginBase
array
getFieldWidgetMap()

Get a map between D6 and D8 widgets for this field type.

from  FieldPluginBase
alterFieldFormatterMigration(MigrationInterface $migration)

Apply any custom processing to the field formatter migration.

from  FieldPluginBase
defineValueProcessPipeline(MigrationInterface $migration, string $field_name, array $data)

Apply any custom processing to the field bundle migrations.

from  FieldPluginBase
string
getFieldType(Row $row)

Computes the destination type of a migrated field.

from  FieldPluginBase

Details

in PluginBase at line 53
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)

Constructs a \Drupal\Component\Plugin\PluginBase object.

Parameters

array $configuration

A configuration array containing information about the plugin instance.
string $plugin_id

The plugin_id for the plugin instance.
mixed $plugin_definition

The plugin implementation definition.

in PluginBase at line 62
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 69
string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 80
string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in PluginBase at line 92
array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

in PluginBase at line 102
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

in DependencySerializationTrait at line 32
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 67
__wakeup()

{@inheritdoc}

in MessengerTrait at line 23
setMessenger(MessengerInterface $messenger)

Sets the messenger.

Parameters

MessengerInterface $messenger

The messenger.

in MessengerTrait at line 33
MessengerInterface messenger()

Gets the messenger.

Return Value

MessengerInterface

The messenger.

in FieldPluginBase at line 25
alterFieldMigration(MigrationInterface $migration)

Apply any custom processing to the field migration.

Parameters

MigrationInterface $migration

The migration entity.

in FieldPluginBase at line 33
alterFieldInstanceMigration(MigrationInterface $migration)

Apply any custom processing to the field instance migration.

Parameters

MigrationInterface $migration

The migration entity.

in FieldPluginBase at line 40
alterFieldWidgetMigration(MigrationInterface $migration)

Apply any custom processing to the field widget migration.

Parameters

MigrationInterface $migration

The migration entity.

in FieldPluginBase at line 51
string getFieldFormatterType(Row $row)

Get the field formatter type from the source.

Parameters

Row $row

The field being migrated.

Return Value

string

The field formatter type.

in FieldPluginBase at line 58
array getFieldFormatterMap()

Get a map between D6 formatters and D8 formatters for this field type.

This is used by static::alterFieldFormatterMigration() in the base class.

Return Value

array

The keys are D6 formatters and the values are D8 formatters.

in FieldPluginBase at line 65
string getFieldWidgetType(Row $row)

Get the field widget type from the source.

Parameters

Row $row

The field being migrated.

Return Value

string

The field widget type.

in FieldPluginBase at line 72
array getFieldWidgetMap()

Get a map between D6 and D8 widgets for this field type.

Return Value

array

The keys are D6 field widget types and the values D8 widgets.

in FieldPluginBase at line 82
alterFieldFormatterMigration(MigrationInterface $migration)

Apply any custom processing to the field formatter migration.

Parameters

MigrationInterface $migration

The migration entity.

in FieldPluginBase at line 97
defineValueProcessPipeline(MigrationInterface $migration, string $field_name, array $data)

Apply any custom processing to the field bundle migrations.

Parameters

MigrationInterface $migration

The migration entity.
string $field_name

The field name we're processing the value for.
array $data

The array of field data from FieldValues::fieldData().

in FieldPluginBase at line 108
string getFieldType(Row $row)

Computes the destination type of a migrated field.

Parameters

Row $row

The field being migrated.

Return Value

string

The destination field type.