class EntityComment
Same name in other branches
- 8.9.x core/modules/comment/src/Plugin/migrate/destination/EntityComment.php \Drupal\comment\Plugin\migrate\destination\EntityComment
- 10 core/modules/comment/src/Plugin/migrate/destination/EntityComment.php \Drupal\comment\Plugin\migrate\destination\EntityComment
- 11.x core/modules/comment/src/Plugin/migrate/destination/EntityComment.php \Drupal\comment\Plugin\migrate\destination\EntityComment
Plugin annotation
@MigrateDestination(
id = "entity:comment"
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface
- class \Drupal\migrate\Plugin\migrate\destination\Entity extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait
- class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase extends \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface
- class \Drupal\comment\Plugin\migrate\destination\EntityComment extends \Drupal\migrate\Plugin\migrate\destination\EntityContentBase
- class \Drupal\migrate\Plugin\migrate\destination\EntityContentBase extends \Drupal\migrate\Plugin\migrate\destination\Entity implements \Drupal\migrate\Audit\HighestIdInterface, \Drupal\migrate\Plugin\MigrateValidatableEntityInterface
- class \Drupal\migrate\Plugin\migrate\destination\Entity extends \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface uses \Drupal\Core\Entity\DependencyTrait, \Drupal\migrate\EntityFieldDefinitionTrait
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate\Plugin\MigrateDestinationInterface, \Drupal\migrate\Plugin\RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of EntityComment
File
-
core/
modules/ comment/ src/ Plugin/ migrate/ destination/ EntityComment.php, line 20
Namespace
Drupal\comment\Plugin\migrate\destinationView source
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');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||
DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||
DependencyTrait::addDependency | protected | function | Adds a dependency. | ||
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::getDestinationModule | public | function | Gets the destination module handling the destination data. | Overrides MigrateDestinationInterface::getDestinationModule | 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 | |
Entity::$bundles | protected | property | The list of the bundles of this entity type. | ||
Entity::$entityFieldManager | protected | property | The entity field manager. | ||
Entity::$storage | protected | property | The entity storage. | ||
Entity::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | |
Entity::fields | public | function | Returns an array of destination fields. | Overrides MigrateDestinationInterface::fields | |
Entity::getBundle | public | function | Gets the bundle for the row taking into account the default. | ||
Entity::getEntity | protected | function | Creates or loads an entity. | 5 | |
Entity::getEntityId | protected | function | Gets the entity ID of the row. | 2 | |
Entity::getKey | protected | function | Returns a specific entity key. | ||
EntityComment::$state | protected | property | The state storage object. | ||
EntityComment::$stubCommentedEntityIds | protected | property | An array of entity IDs for the 'commented entity' keyed by entity type. | ||
EntityComment::create | public static | function | Creates an instance of the plugin. | Overrides EntityContentBase::create | |
EntityComment::import | public | function | Import the row. | Overrides EntityContentBase::import | |
EntityComment::processStubRow | protected | function | Populates as much of the stub row as possible. | Overrides EntityContentBase::processStubRow | |
EntityComment::__construct | public | function | Builds a comment entity destination. | Overrides EntityContentBase::__construct | |
EntityContentBase::$accountSwitcher | protected | property | The account switcher service. | ||
EntityContentBase::$fieldTypeManager | protected | property | Field type plugin manager. | ||
EntityContentBase::getHighestId | public | function | Returns the highest ID tracked by the implementing plugin. | Overrides HighestIdInterface::getHighestId | 2 |
EntityContentBase::getIds | public | function | Gets the destination IDs. | Overrides MigrateDestinationInterface::getIds | 2 |
EntityContentBase::isEntityValidationRequired | public | function | Returns a state of whether an entity needs to be validated before saving. | Overrides MigrateValidatableEntityInterface::isEntityValidationRequired | |
EntityContentBase::isTranslationDestination | public | function | |||
EntityContentBase::rollback | public | function | Delete the specified destination object from the target Drupal. | Overrides Entity::rollback | 1 |
EntityContentBase::save | protected | function | Saves the entity. | 3 | |
EntityContentBase::updateEntity | protected | function | Updates an entity with the new values from row. | 3 | |
EntityContentBase::validateEntity | public | function | Validates the entity. | Overrides MigrateValidatableEntityInterface::validateEntity | |
EntityFieldDefinitionTrait::getDefinitionFromEntity | protected | function | Gets the field definition from a specific entity base field. | ||
EntityFieldDefinitionTrait::getEntityTypeId | protected static | function | Finds the entity type from configuration or plugin ID. | 3 | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.