abstract class DomProcessBase in Migrate Plus 8.5

Base class for process plugins that work with \DOMDocument objects.

Use Dom::import() to convert a string to a \DOMDocument object, then plugins derived from this class to manipulate the object, then Dom::export() to convert back to a string.

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_plus\Plugin\migrate\process\DomProcessBase

2 files declare their use of DomProcessBase

DomRemove.php in src/Plugin/migrate/process/DomRemove.php

DomSelect.php in src/Plugin/migrate/process/DomSelect.php

File

src/Plugin/migrate/process/DomProcessBase.php, line 15

Namespace

Drupal\migrate_plus\Plugin\migrate\process

abstract class DomProcessBase extends ProcessPluginBase {

  /**
   * Document to use.
   *
   * @var \DOMDocument
   */
  protected $document;

  /**
   * Xpath query object.
   *
   * @var \DOMXPath
   */
  protected $xpath;

  /**
   * Initialize the class properties.
   *
   * @param mixed $value
   *   Process plugin value.
   * @param string $destination_property
   *   The name of the destination being processed. Used to generate an error
   *   message.
   *
   * @throws \Drupal\migrate\MigrateSkipRowException
   *   If $value is not a \DOMDocument object.
   */
  protected function init($value, $destination_property) {
    if (!$value instanceof \DOMDocument) {
      $message = sprintf('The %s plugin in the %s process pipeline requires a \\DOMDocument object. You can use the dom plugin to convert a string to \\DOMDocument.', $this
        ->getPluginId(), $destination_property);
      throw new MigrateSkipRowException($message);
    }
    $this->document = $value;
    $this->xpath = new \DOMXPath($this->document);
  }

}

Members

Name	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.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
ProcessPluginBase::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple	3
ProcessPluginBase::transform	public	function	Performs the associated process. Overrides MigrateProcessInterface::transform	70
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.