class MigrateRowDeleteEvent in Zircon Profile 8

Wraps a row deletion event for event listeners.

Hierarchy

• class \Symfony\Component\EventDispatcher\Event
  • class \Drupal\migrate\Event\MigrateRowDeleteEvent

1 file declares its use of MigrateRowDeleteEvent

MigrateExecutable.php in core/modules/migrate/src/MigrateExecutable.php

Contains \Drupal\migrate\MigrateExecutable.

File

core/modules/migrate/src/Event/MigrateRowDeleteEvent.php, line 16

Contains \Drupal\migrate\Event\MigrateRowDeleteEvent.

Namespace

Drupal\migrate\Event

class MigrateRowDeleteEvent extends Event {

  /**
   * Migration entity.
   *
   * @var \Drupal\migrate\Entity\MigrationInterface
   */
  protected $migration;

  /**
   * Values representing the destination ID.
   *
   * @var array
   */
  protected $destinationIdValues;

  /**
   * Constructs a row deletion event object.
   *
   * @param \Drupal\migrate\Entity\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\Entity\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

Name	Modifiers	Type	Description	Overrides
Event::$dispatcher	private	property
Event::$name	private	property
Event::$propagationStopped	private	property
Event::getDispatcher Deprecated	public	function	Returns the EventDispatcher that dispatches this Event.
Event::getName Deprecated	public	function	Gets the event's name.
Event::isPropagationStopped	public	function	Returns whether further event listeners should be triggered.
Event::setDispatcher Deprecated	public	function	Stores the EventDispatcher that dispatches this Event.
Event::setName Deprecated	public	function	Sets the event's name property.
Event::stopPropagation	public	function	Stops the propagation of the event to further event listeners.
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.