abstract class BuilderBase in Zircon Profile 8

Base class for builder plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\builder\BuilderBase implements MigrateBuilderInterface

4 files declare their use of BuilderBase

CckBuilder.php in core/modules/migrate_drupal/src/Plugin/migrate/builder/CckBuilder.php

Contains \Drupal\migrate_drupal\Plugin\migrate\builder\CckBuilder.

ProfileValues.php in core/modules/user/src/Plugin/migrate/builder/d6/ProfileValues.php

Contains \Drupal\user\Plugin\migrate\builder\d6\ProfileValues.

TermNode.php in core/modules/taxonomy/src/Plugin/migrate/builder/d6/TermNode.php

Contains \Drupal\taxonomy\Plugin\migrate\builder\d6\TermNode.

User.php in core/modules/user/src/Plugin/migrate/builder/d7/User.php

Contains \Drupal\user\Plugin\migrate\builder\d7\User.

File

core/modules/migrate/src/Plugin/migrate/builder/BuilderBase.php, line 17

Contains \Drupal\migrate\Plugin\migrate\builder\BuilderBase.

Namespace

Drupal\migrate\Plugin\migrate\builder

abstract class BuilderBase extends PluginBase implements MigrateBuilderInterface {

  /**
   * Returns a fully initialized instance of a source plugin.
   *
   * @param string $plugin_id
   *   The plugin ID.
   * @param array $configuration
   *   (optional) Additional configuration for the plugin.
   *
   * @return \Drupal\migrate\Plugin\MigrateSourceInterface|\Drupal\migrate\Plugin\RequirementsInterface
   *   The fully initialized source plugin.
   */
  protected function getSourcePlugin($plugin_id, array $configuration = []) {
    $configuration['plugin'] = $plugin_id;

    // By default, SqlBase subclasses will try to join on a map table. But in
    // this case we're trying to use the source plugin as a detached iterator
    // over the source data, so we don't want to join on (or create) the map
    // table.
    // @see SqlBase::initializeIterator()
    $configuration['ignore_map'] = TRUE;

    // Source plugins are tightly coupled to migration entities, so we need
    // to create a fake migration in order to properly initialize the plugin.
    $values = [
      'id' => uniqid(),
      'source' => $configuration,
      // Since this isn't a real migration, we don't want a real destination --
      // the 'null' destination is perfect for this.
      'destination' => [
        'plugin' => 'null',
      ],
    ];
    return Migration::create($values)
      ->getSourcePlugin();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BuilderBase::getSourcePlugin	protected	function	Returns a fully initialized instance of a source plugin.
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
MigrateBuilderInterface::buildMigrations	public	function	Builds migration entities based on a template.	6
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	2
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.
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
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct	public	function	Constructs a Drupal\Component\Plugin\PluginBase object.	69
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.
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.