class MachineName
Same name in this branch
- 11.x core/modules/views/src/Plugin/views/field/MachineName.php \Drupal\views\Plugin\views\field\MachineName
- 11.x core/lib/Drupal/Core/Render/Element/MachineName.php \Drupal\Core\Render\Element\MachineName
Same name in other branches
- 9 core/modules/views/src/Plugin/views/field/MachineName.php \Drupal\views\Plugin\views\field\MachineName
- 9 core/modules/migrate/src/Plugin/migrate/process/MachineName.php \Drupal\migrate\Plugin\migrate\process\MachineName
- 9 core/lib/Drupal/Core/Render/Element/MachineName.php \Drupal\Core\Render\Element\MachineName
- 8.9.x core/modules/views/src/Plugin/views/field/MachineName.php \Drupal\views\Plugin\views\field\MachineName
- 8.9.x core/modules/migrate/src/Plugin/migrate/process/MachineName.php \Drupal\migrate\Plugin\migrate\process\MachineName
- 8.9.x core/lib/Drupal/Core/Render/Element/MachineName.php \Drupal\Core\Render\Element\MachineName
- 10 core/modules/views/src/Plugin/views/field/MachineName.php \Drupal\views\Plugin\views\field\MachineName
- 10 core/modules/migrate/src/Plugin/migrate/process/MachineName.php \Drupal\migrate\Plugin\migrate\process\MachineName
- 10 core/lib/Drupal/Core/Render/Element/MachineName.php \Drupal\Core\Render\Element\MachineName
Creates a machine name.
The machine_name process plugin takes the source value and turns it into a machine-readable name via the following four steps: 1. Language decorations and accents are removed by transliterating the source value. 2. The resulting value is made lowercase. 3. Any special characters are replaced with an underscore. By default, anything that is not a number or a letter is replaced, but additional characters can be allowed or further restricted by using the replace_pattern configuration as described below. 4. Any duplicate underscores either in the source value or as a result of replacing special characters are removed.
Available configuration keys:
- replace_pattern: (optional) A custom regular expression pattern to replace special characters with an underscore using preg_replace(). This can be used to allow additional characters in the machine name. Defaults to /[^a-z0-9_]+/
Example:
process:
bar:
plugin: machine_name
source: foo
If the value of foo in the source is 'áéí!' then the destination value of bar will be 'aei_'.
process:
bar:
plugin: machine_name
source: foo
replace_pattern: '/[^a-z0-9_.]+/'
Here the replace pattern does not match the '.' character (as it is included in the list of characters not to match) so if the value of foo in the source is 'áéí!.jpg' then the destination value of bar will be 'aei_.jpg'.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\migrate\Plugin\migrate\process\MachineName extends \Drupal\migrate\ProcessPluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface
- class \Drupal\migrate\ProcessPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateProcessInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of MachineName
See also
\Drupal\migrate\Plugin\MigrateProcessInterface
1 file declares its use of MachineName
- MachineNameTest.php in core/
modules/ migrate/ tests/ src/ Unit/ process/ MachineNameTest.php
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ process/ MachineName.php, line 62
Namespace
Drupal\migrate\Plugin\migrate\processView source
class MachineName extends ProcessPluginBase implements ContainerFactoryPluginInterface {
/**
* The transliteration service.
*
* @var \Drupal\Component\Transliteration\TransliterationInterface
*/
protected $transliteration;
/**
* The regular expression pattern.
*
* @var string
*/
protected $replacePattern;
/**
* Constructs a MachineName plugin.
*
* @param array $configuration
* The plugin configuration.
* @param string $plugin_id
* The plugin ID.
* @param mixed $plugin_definition
* The plugin definition.
* @param \Drupal\Component\Transliteration\TransliterationInterface $transliteration
* The transliteration service.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, TransliterationInterface $transliteration) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->transliteration = $transliteration;
$this->replacePattern = $this->configuration['replace_pattern'] ?? '/[^a-z0-9_]+/';
if (!is_string($this->replacePattern)) {
throw new MigrateException('The replace pattern should be a string');
}
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('transliteration'));
}
/**
* {@inheritdoc}
*/
public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
$new_value = $this->transliteration
->transliterate($value, LanguageInterface::LANGCODE_DEFAULT, '_');
$new_value = strtolower($new_value);
$new_value = preg_replace($this->replacePattern, '_', $new_value);
return preg_replace('/_+/', '_', $new_value);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
MachineName::$replacePattern | protected | property | The regular expression pattern. | ||
MachineName::$transliteration | protected | property | The transliteration service. | ||
MachineName::create | public static | function | Overrides ContainerFactoryPluginInterface::create | ||
MachineName::transform | public | function | Overrides ProcessPluginBase::transform | ||
MachineName::__construct | public | function | Constructs a MachineName plugin. | ||
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin ID of the plugin instance. | 2 | |
ProcessPluginBase::$stopPipeline | protected | property | Determines if processing of the pipeline is stopped. | ||
ProcessPluginBase::isPipelineStopped | public | function | Overrides MigrateProcessInterface::isPipelineStopped | ||
ProcessPluginBase::multiple | public | function | Overrides MigrateProcessInterface::multiple | 3 | |
ProcessPluginBase::reset | public | function | Overrides MigrateProcessInterface::reset | ||
ProcessPluginBase::stopPipeline | protected | function | Stops pipeline processing after this plugin finishes. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.