EntityComment.php

Same filename in other branches
  1. 9 core/modules/comment/src/Plugin/migrate/destination/EntityComment.php
  2. 8.9.x core/modules/comment/src/Plugin/migrate/destination/EntityComment.php
  3. 10 core/modules/comment/src/Plugin/migrate/destination/EntityComment.php

Namespace

Drupal\comment\Plugin\migrate\destination

File

core/modules/comment/src/Plugin/migrate/destination/EntityComment.php

View source
<?php

namespace Drupal\comment\Plugin\migrate\destination;

use Drupal\Core\Entity\EntityFieldManagerInterface;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\Core\Session\AccountSwitcherInterface;
use Drupal\Core\State\StateInterface;
use Drupal\migrate\Attribute\MigrateDestination;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;
use Drupal\migrate\Row;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Comment entity destination.
 */
class EntityComment extends EntityContentBase {
    
    /**
     * The state storage object.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected $state;
    
    /**
     * An array of entity IDs for the 'commented entity' keyed by entity type.
     *
     * @var array
     */
    protected $stubCommentedEntityIds;
    
    /**
     * Builds a comment entity destination.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration.
     * @param \Drupal\Core\Entity\EntityStorageInterface $storage
     *   The storage for this entity type.
     * @param array $bundles
     *   The list of bundles this entity type has.
     * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
     *   The entity field manager.
     * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
     *   The field type plugin manager service.
     * @param \Drupal\Core\State\StateInterface $state
     *   The state storage object.
     * @param \Drupal\Core\Session\AccountSwitcherInterface|null $account_switcher
     *   The account switcher service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityFieldManagerInterface $entity_field_manager, FieldTypePluginManagerInterface $field_type_manager, StateInterface $state, ?AccountSwitcherInterface $account_switcher = NULL) {
        parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_field_manager, $field_type_manager, $account_switcher);
        $this->state = $state;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        $entity_type = static::getEntityTypeId($plugin_id);
        return new static($configuration, $plugin_id, $plugin_definition, $migration, $container->get('entity_type.manager')
            ->getStorage($entity_type), array_keys($container->get('entity_type.bundle.info')
            ->getBundleInfo($entity_type)), $container->get('entity_field.manager'), $container->get('plugin.manager.field.field_type'), $container->get('state'), $container->get('account_switcher'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function import(Row $row, array $old_destination_id_values = []) {
        if ($row->isStub() && ($state = $this->state
            ->get('comment.maintain_entity_statistics', 0))) {
            $this->state
                ->set('comment.maintain_entity_statistics', 0);
        }
        $return = parent::import($row, $old_destination_id_values);
        if ($row->isStub() && $state) {
            $this->state
                ->set('comment.maintain_entity_statistics', $state);
        }
        return $return;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function processStubRow(Row $row) {
        parent::processStubRow($row);
        // Neither uid nor name is required in itself, but it is required to set one
        // of them.
        $row->setDestinationProperty('name', 'anonymous_stub');
    }

}

Classes

Title Deprecated Summary
EntityComment Comment entity destination.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.