class MigrateRowDeleteEvent
Same name in other branches
- 9 core/modules/migrate/src/Event/MigrateRowDeleteEvent.php \Drupal\migrate\Event\MigrateRowDeleteEvent
- 10 core/modules/migrate/src/Event/MigrateRowDeleteEvent.php \Drupal\migrate\Event\MigrateRowDeleteEvent
- 11.x core/modules/migrate/src/Event/MigrateRowDeleteEvent.php \Drupal\migrate\Event\MigrateRowDeleteEvent
Wraps a row deletion event for event listeners.
Hierarchy
- class \Drupal\migrate\Event\MigrateRowDeleteEvent extends \Symfony\Component\EventDispatcher\Event
Expanded class hierarchy of MigrateRowDeleteEvent
2 files declare their use of MigrateRowDeleteEvent
- MigrateExecutable.php in core/
modules/ migrate/ src/ MigrateExecutable.php - MigrateUpgradeImportBatch.php in core/
modules/ migrate_drupal_ui/ src/ Batch/ MigrateUpgradeImportBatch.php
File
-
core/
modules/ migrate/ src/ Event/ MigrateRowDeleteEvent.php, line 11
Namespace
Drupal\migrate\EventView source
class MigrateRowDeleteEvent extends Event {
/**
* Migration entity.
*
* @var \Drupal\migrate\Plugin\MigrationInterface
*/
protected $migration;
/**
* Values representing the destination ID.
*
* @var array
*/
protected $destinationIdValues;
/**
* Constructs a row deletion event object.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* Migration entity.
* @param array $destination_id_values
* Values represent the destination ID.
*/
public function __construct(MigrationInterface $migration, $destination_id_values) {
$this->migration = $migration;
$this->destinationIdValues = $destination_id_values;
}
/**
* Gets the migration entity.
*
* @return \Drupal\migrate\Plugin\MigrationInterface
* The migration being rolled back.
*/
public function getMigration() {
return $this->migration;
}
/**
* Gets the destination ID values.
*
* @return array
* The destination ID as an array.
*/
public function getDestinationIdValues() {
return $this->destinationIdValues;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
MigrateRowDeleteEvent::$destinationIdValues | protected | property | Values representing the destination ID. |
MigrateRowDeleteEvent::$migration | protected | property | Migration entity. |
MigrateRowDeleteEvent::getDestinationIdValues | public | function | Gets the destination ID values. |
MigrateRowDeleteEvent::getMigration | public | function | Gets the migration entity. |
MigrateRowDeleteEvent::__construct | public | function | Constructs a row deletion event object. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.