class Log in Drupal 9
Same name in this branch
- 9 core/lib/Drupal/Core/Database/Log.php \Drupal\Core\Database\Log
- 9 core/modules/migrate/src/Plugin/migrate/process/Log.php \Drupal\migrate\Plugin\migrate\process\Log
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/process/Log.php \Drupal\migrate\Plugin\migrate\process\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 implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\migrate\Plugin\migrate\process\Log
- class \Drupal\migrate\ProcessPluginBase implements MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
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
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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
Log:: |
public | function |
Performs the associated process. Overrides ProcessPluginBase:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
ProcessPluginBase:: |
public | function |
Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface:: |
3 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |