annotate core/modules/migrate/src/Event/MigrateRowDeleteEvent.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\migrate\Event;
Chris@0 4
Chris@0 5 use Drupal\migrate\Plugin\MigrationInterface;
Chris@0 6 use Symfony\Component\EventDispatcher\Event;
Chris@0 7
Chris@0 8 /**
Chris@0 9 * Wraps a row deletion event for event listeners.
Chris@0 10 */
Chris@0 11 class MigrateRowDeleteEvent extends Event {
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Migration entity.
Chris@0 15 *
Chris@0 16 * @var \Drupal\migrate\Plugin\MigrationInterface
Chris@0 17 */
Chris@0 18 protected $migration;
Chris@0 19
Chris@0 20 /**
Chris@0 21 * Values representing the destination ID.
Chris@0 22 *
Chris@0 23 * @var array
Chris@0 24 */
Chris@0 25 protected $destinationIdValues;
Chris@0 26
Chris@0 27 /**
Chris@0 28 * Constructs a row deletion event object.
Chris@0 29 *
Chris@0 30 * @param \Drupal\migrate\Plugin\MigrationInterface $migration
Chris@0 31 * Migration entity.
Chris@0 32 * @param array $destination_id_values
Chris@0 33 * Values represent the destination ID.
Chris@0 34 */
Chris@0 35 public function __construct(MigrationInterface $migration, $destination_id_values) {
Chris@0 36 $this->migration = $migration;
Chris@0 37 $this->destinationIdValues = $destination_id_values;
Chris@0 38 }
Chris@0 39
Chris@0 40 /**
Chris@0 41 * Gets the migration entity.
Chris@0 42 *
Chris@0 43 * @return \Drupal\migrate\Plugin\MigrationInterface
Chris@0 44 * The migration being rolled back.
Chris@0 45 */
Chris@0 46 public function getMigration() {
Chris@0 47 return $this->migration;
Chris@0 48 }
Chris@0 49
Chris@0 50 /**
Chris@0 51 * Gets the destination ID values.
Chris@0 52 *
Chris@0 53 * @return array
Chris@0 54 * The destination ID as an array.
Chris@0 55 */
Chris@0 56 public function getDestinationIdValues() {
Chris@0 57 return $this->destinationIdValues;
Chris@0 58 }
Chris@0 59
Chris@0 60 }