class MachineName in Drupal 9

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'.

Plugin annotation

@MigrateProcessPlugin(
  id = "machine_name"
)

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\MachineName implements ContainerFactoryPluginInterface

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 65

Namespace

Drupal\migrate\Plugin\migrate\process

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

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
MachineName::$replacePattern	protected	property	The regular expression pattern.
MachineName::$transliteration	protected	property	The transliteration service.
MachineName::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
MachineName::transform	public	function	Performs the associated process. Overrides ProcessPluginBase::transform
MachineName::__construct	public	function	Constructs a MachineName plugin. Overrides PluginBase::__construct
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.
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.