You are here

Home » API reference » Migrate Plus 8.4 » DomStrReplace.php

class DomStrReplace in Migrate Plus 8.4

Same name and namespace in other branches
  1. 8.5 src/Plugin/migrate/process/DomStrReplace.php \Drupal\migrate_plus\Plugin\migrate\process\DomStrReplace

String replacements on a source dom.

Analogous to str_replace process plugin, but based on a \DOMDocument instead of a string. Meant to be used after dom process plugin.

Available configuration keys:

  • mode: What to modify. Possible values:

    • attribute: One element attribute.
  • expression: XPath query expression that will produce the \DOMNodeList to walk.
  • attribute_options: A map of options related to the attribute mode. Required when mode is attribute. The keys can be:

    • name: Name of the attribute to match and modify.
  • search: pattern to match.
  • replace: value to replace the searched pattern with.
  • regex: Use regular expression replacement.
  • case_insensitive: Case insensitive search. Only valid when regex is false.

Examples:


process:
  'body/value':
    -
      plugin: dom
      method: import
      source: 'body/0/value'
    -
      plugin: dom_str_replace
      mode: attribute
      expression: '//a'
      attribute_options:
        name: href
      search: 'foo'
      replace: 'bar'
    -
      plugin: dom_str_replace
      mode: attribute
      expression: '//a'
      attribute_options:
        name: href
      regex: true
      search: '/foo/'
      replace: 'bar'
    -
      plugin: dom
      method: export

Plugin annotation


@MigrateProcessPlugin(
  id = "dom_str_replace"
)

Hierarchy

Expanded class hierarchy of DomStrReplace

1 file declares its use of DomStrReplace
DomStrReplaceTest.php in tests/src/Unit/process/DomStrReplaceTest.php

File

src/Plugin/migrate/process/DomStrReplace.php, line 64

Namespace

Drupal\migrate_plus\Plugin\migrate\process
View source 
class DomStrReplace extends DomProcessBase {

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->configuration += [
      'case_insensitive' => FALSE,
      'regex' => FALSE,
    ];
    $options_validation = [
      'expression' => NULL,
      'mode' => [
        'attribute',
      ],
      // @todo Move out once another mode is supported.
      // @see https://www.drupal.org/project/migrate_plus/issues/3042833
      'attribute_options' => NULL,
      'search' => NULL,
      'replace' => NULL,
    ];
    foreach ($options_validation as $option_name => $possible_values) {
      if (empty($this->configuration[$option_name])) {
        throw new InvalidPluginDefinitionException($this
          ->getPluginId(), "Configuration option '{$option_name}' is required.");
      }
      if (!is_null($possible_values) && !in_array($this->configuration[$option_name], $possible_values)) {
        throw new InvalidPluginDefinitionException($this
          ->getPluginId(), sprintf('Configuration option "%s" only accepts the following values: %s.', $option_name, implode(', ', $possible_values)));
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
    $this
      ->init($value, $destination_property);
    foreach ($this->xpath
      ->query($this->configuration['expression']) as $html_node) {
      $subject = $this
        ->getSubject($html_node);
      if (empty($subject)) {

        // Could not find subject, skip processing.
        continue;
      }
      $search = $this
        ->getSearch();
      $replace = $this
        ->getReplace();
      $this
        ->doReplace($html_node, $search, $replace, $subject);
    }
    return $this->document;
  }

  /**
   * Retrieves the right subject string.
   *
   * @param \DOMElement $node
   *   The current element from iteration.
   *
   * @return string
   *   The string to use a subject on search.
   */
  protected function getSubject(\DOMElement $node) {
    switch ($this->configuration['mode']) {
      case 'attribute':
        return $node
          ->getAttribute($this->configuration['attribute_options']['name']);
    }
  }

  /**
   * Retrieves the right search string based on configuration.
   *
   * @return string
   *   The value to be searched.
   */
  protected function getSearch() {
    switch ($this->configuration['mode']) {
      case 'attribute':
        return $this->configuration['search'];
    }
  }

  /**
   * Retrieves the right replace string based on configuration.
   *
   * @return string
   *   The value to use for replacement.
   */
  protected function getReplace() {
    switch ($this->configuration['mode']) {
      case 'attribute':
        return $this->configuration['replace'];
    }
  }

  /**
   * Retrieves the right replace string based on configuration.
   *
   * @param \DOMElement $html_node
   *   The current element from iteration.
   * @param string $search
   *   The search string or pattern.
   * @param string $replace
   *   The replacement string.
   * @param string $subject
   *   The string on which to perform the substitution.
   */
  protected function doReplace(\DOMElement $html_node, $search, $replace, $subject) {
    if ($this->configuration['regex']) {
      $function = 'preg_replace';
    }
    elseif ($this->configuration['case_insensitive']) {
      $function = 'str_ireplace';
    }
    else {
      $function = "str_replace";
    }
    $new_subject = $function($search, $replace, $subject);
    $this
      ->postReplace($html_node, $new_subject);
  }

  /**
   * Performs post-replace actions.
   *
   * @param \DOMElement $html_node
   *   The current element from iteration.
   * @param string $new_subject
   *   The new value to use.
   */
  protected function postReplace(\DOMElement $html_node, $new_subject) {
    switch ($this->configuration['mode']) {
      case 'attribute':
        $html_node
          ->setAttribute($this->configuration['attribute_options']['name'], $new_subject);
    }
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
DomProcessBase::$document protected property Document to use.
DomProcessBase::$xpath protected property Xpath query object.
DomProcessBase::init protected function Initialize the class properties.
DomStrReplace::doReplace protected function Retrieves the right replace string based on configuration.
DomStrReplace::getReplace protected function Retrieves the right replace string based on configuration.
DomStrReplace::getSearch protected function Retrieves the right search string based on configuration.
DomStrReplace::getSubject protected function Retrieves the right subject string.
DomStrReplace::postReplace protected function Performs post-replace actions.
DomStrReplace::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
DomStrReplace::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
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.
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
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.