class Log
Same name in this branch
- 9 core/lib/Drupal/Core/Database/Log.php \Drupal\Core\Database\Log
Same name and namespace in other branches
- 8.9.x core/modules/migrate/src/Plugin/migrate/process/Log.php \Drupal\migrate\Plugin\migrate\process\Log
- 8.9.x core/lib/Drupal/Core/Database/Log.php \Drupal\Core\Database\Log
- 10 core/modules/migrate/src/Plugin/migrate/process/Log.php \Drupal\migrate\Plugin\migrate\process\Log
- 10 core/lib/Drupal/Core/Database/Log.php \Drupal\Core\Database\Log
- 11.x core/modules/migrate/src/Plugin/migrate/process/Log.php \Drupal\migrate\Plugin\migrate\process\Log
- 11.x core/lib/Drupal/Core/Database/Log.php \Drupal\Core\Database\Log
Logs values without changing them.
The log plugin will log the values that are being processed by other plugins.
Example:
process:
bar:
plugin: log
source: foo
Plugin annotation
@MigrateProcessPlugin(
id = "log"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\migrate\Plugin\MigrateProcessInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\migrate\Plugin\migrate\process\Log implements \Drupal\migrate\ProcessPluginBase
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\migrate\Plugin\MigrateProcessInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of Log
See also
\Drupal\migrate\Plugin\MigrateProcessInterface
1 file declares its use of Log
- LogTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ LogTest.php
17 string references to 'Log'
- d6_node.yml in core/
modules/ node/ migrations/ d6_node.yml - core/modules/node/migrations/d6_node.yml
- d6_node_complete.yml in core/
modules/ node/ migrations/ d6_node_complete.yml - core/modules/node/migrations/d6_node_complete.yml
- d6_node_revision.yml in core/
modules/ node/ migrations/ d6_node_revision.yml - core/modules/node/migrations/d6_node_revision.yml
- d6_node_translation.yml in core/
modules/ content_translation/ migrations/ d6_node_translation.yml - core/modules/content_translation/migrations/d6_node_translation.yml
- d7_node.yml in core/
modules/ node/ migrations/ d7_node.yml - core/modules/node/migrations/d7_node.yml
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ process/ Log.php, line 28
Namespace
Drupal\migrate\Plugin\migrate\processView source
class Log extends ProcessPluginBase {
/**
* {@inheritdoc}
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
$is_object = is_object($value);
if (is_null($value) || is_bool($value)) {
$export = var_export($value, TRUE);
}
elseif (is_float($value)) {
$export = sprintf('%f', $value);
}
elseif ($is_object && method_exists($value, 'toString')) {
$export = print_r($value->toString(), TRUE);
}
elseif ($is_object && method_exists($value, 'toArray')) {
$export = print_r($value->toArray(), TRUE);
}
elseif (is_string($value) || is_numeric($value) || is_array($value)) {
$export = print_r($value, TRUE);
}
elseif ($is_object && method_exists($value, '__toString')) {
$export = print_r((string) $value, TRUE);
}
else {
$export = NULL;
}
$class_name = $export !== NULL && $is_object ? $class_name = get_class($value) . ":\n" : '';
$message = $export === NULL ? "Unable to log the value for '{$destination_property}'" : "'{$destination_property}' value is {$class_name}'{$export}'";
// Log the value.
$migrate_executable->saveMessage($message);
// Pass through the same value we received.
return $value;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | 2 | ||
DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
Log::transform | public | function | Performs the associated process. | Overrides ProcessPluginBase::transform | |
MessengerTrait::$messenger | protected | property | The messenger. | 27 | |
MessengerTrait::messenger | public | function | Gets the messenger. | 27 | |
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 | 2 |
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. | 85 | |
ProcessPluginBase::multiple | public | function | Indicates whether the returned value requires multiple handling. | Overrides MigrateProcessInterface::multiple | 3 |
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.