class Callback in Zircon Profile 8

This plugin allows source value to be passed to a callback.

The current value is passed to a callable that returns the processed value. This plugin allows simple processing of the value, such as strtolower(). The callable takes the value as the single mandatory argument. No additional arguments can be passed to the callback as this would make the migration YAML file too complex.

Plugin annotation

@MigrateProcessPlugin(
  id = "callback"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
      • class \Drupal\migrate\Plugin\migrate\process\Callback

1 file declares its use of Callback

CallbackTest.php in core/modules/migrate/tests/src/Unit/process/CallbackTest.php

Contains \Drupal\Tests\migrate\Unit\process\CallbackTest.

3 string references to 'Callback'

ConstraintManager::registerDefinitions in core/lib/Drupal/Core/Validation/ConstraintManager.php

Callback for registering definitions for constraints shipped with Symfony.

RecursiveContextualValidatorTest::setupTypedData in core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php

Setups a typed data object used for test purposes.

RecursiveContextualValidatorTest::testBasicValidateWithConstraint in core/tests/Drupal/Tests/Core/TypedData/RecursiveContextualValidatorTest.php

@covers ::validate

File

core/modules/migrate/src/Plugin/migrate/process/Callback.php, line 27

Contains \Drupal\migrate\Plugin\migrate\process\Callback.

Namespace

Drupal\migrate\Plugin\migrate\process

class Callback extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (is_callable($this->configuration['callable'])) {
      $value = call_user_func($this->configuration['callable'], $value);
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Callback::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
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
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
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	2
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.