You are here

class Debug in Migrate Devel 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/migrate/process/Debug.php \Drupal\migrate_devel\Plugin\migrate\process\Debug

Debug the process pipeline.

Prints the input value, assuming that you are running the migration from the command line, and sends it to the next step in the pipeline unaltered.

Available configuration keys:

  • label: (optional) a string to print before the debug output. Include any trailing punctuation or space characters.
  • multiple: (optional) set to TRUE to ask the next step in the process pipeline to process array values individually, like the multiple_values plugin from the Migrate Plus module.

Examples:


process:
  field_tricky:
    -
      plugin: debug
      source: whatever
    -
      plugin: next

This will print the source before passing it to the next plugin.


process:
  field_tricky:
    -
      plugin: debug
      source: whatever
      label: 'Step 1: '
      multiple: true
    -
      plugin: next

This does the same thing, but ensures that the next plugin will be called once for each item in the source, if the source is an array. It will also print "Debug Step 1: " before printing the source.

Plugin annotation


@MigrateProcessPlugin(
  id = "debug",
  handle_multiples = TRUE
)

Hierarchy

Expanded class hierarchy of Debug

See also

\Drupal\migrate\Plugin\MigrateProcessInterface

File

src/Plugin/migrate/process/Debug.php, line 59

Namespace

Drupal\migrate_devel\Plugin\migrate\process
View source
class Debug extends ProcessPluginBase {

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    if (isset($this->configuration['label'])) {
      print_r($this->configuration['label']);
    }
    print_r($value);
    if (!is_array($value)) {
      print_r(PHP_EOL);
    }
    return $value;
  }

  /**
   * {@inheritdoc}
   */
  public function multiple() {
    return !empty($this->configuration['multiple']);
  }

}

Members

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