abstract class ComponentEntityDisplayBase in Zircon Profile 8.0

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase

1 file declares its use of ComponentEntityDisplayBase

PerComponentEntityDisplayTest.php in core/modules/migrate/tests/src/Unit/destination/PerComponentEntityDisplayTest.php

Contains \Drupal\Tests\migrate\Unit\destination\PerComponentEntityDisplayTest.

File

core/modules/migrate/src/Plugin/migrate/destination/ComponentEntityDisplayBase.php, line 13

Contains \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase.

Namespace

Drupal\migrate\Plugin\migrate\destination

abstract class ComponentEntityDisplayBase extends DestinationBase {
  const MODE_NAME = '';

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = array()) {
    $values = array();

    // array_intersect_key() won't work because the order is important because
    // this is also the return value.
    foreach (array_keys($this
      ->getIds()) as $id) {
      $values[$id] = $row
        ->getDestinationProperty($id);
    }
    $entity = $this
      ->getEntity($values['entity_type'], $values['bundle'], $values[static::MODE_NAME]);
    if (!$row
      ->getDestinationProperty('hidden')) {
      $entity
        ->setComponent($values['field_name'], $row
        ->getDestinationProperty('options') ?: array());
    }
    else {
      $entity
        ->removeComponent($values['field_name']);
    }
    $entity
      ->save();
    return array_values($values);
  }

  /**
   * {@inheritdoc}
   */
  public function getIds() {
    $ids['entity_type']['type'] = 'string';
    $ids['bundle']['type'] = 'string';
    $ids[static::MODE_NAME]['type'] = 'string';
    $ids['field_name']['type'] = 'string';
    return $ids;
  }

  /**
   * {@inheritdoc}
   */
  public function fields(MigrationInterface $migration = NULL) {

    // This is intentionally left empty.
  }

  /**
   * Get the entity.
   *
   * @param string $entity_type
   *   The entity type to retrieve.
   * @param string $bundle
   *   The entity bundle.
   * @param string $mode
   *   The display mode.
   *
   * @return \Drupal\Core\Entity\Display\EntityDisplayInterface
   *   The entity display object.
   */
  protected abstract function getEntity($entity_type, $bundle, $mode);

}

Members

Name	Modifiers	Type	Description	Overrides
ComponentEntityDisplayBase::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
ComponentEntityDisplayBase::getEntity	abstract protected	function	Get the entity.	3
ComponentEntityDisplayBase::getIds	public	function	Get the destination ids. Overrides MigrateDestinationInterface::getIds
ComponentEntityDisplayBase::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
ComponentEntityDisplayBase::MODE_NAME		constant		3
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
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback	1
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
DestinationBase::__construct	public	function	Constructs an entity destination plugin. Overrides PluginBase::__construct	8
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
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.