You are here

class MigrateImportEvent in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/migrate/src/Event/MigrateImportEvent.php \Drupal\migrate\Event\MigrateImportEvent

Wraps a pre- or post-import event for event listeners.

Hierarchy

Expanded class hierarchy of MigrateImportEvent

2 files declare their use of MigrateImportEvent
MigrateEventsTest.php in core/modules/migrate/src/Tests/MigrateEventsTest.php
Contains \Drupal\migrate\Tests\MigrateEventsTest.
MigrateExecutable.php in core/modules/migrate/src/MigrateExecutable.php
Contains \Drupal\migrate\MigrateExecutable.

File

core/modules/migrate/src/Event/MigrateImportEvent.php, line 16
Contains \Drupal\migrate\Event\MigrateImportEvent.

Namespace

Drupal\migrate\Event
View source
class MigrateImportEvent extends Event {

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

  /**
   * Constructs an import event object.
   *
   * @param \Drupal\migrate\Entity\MigrationInterface $migration
   *   Migration entity.
   */
  public function __construct(MigrationInterface $migration) {
    $this->migration = $migration;
  }

  /**
   * Gets the migration entity.
   *
   * @return \Drupal\migrate\Entity\MigrationInterface
   *   The migration entity involved.
   */
  public function getMigration() {
    return $this->migration;
  }

}

Members

Namesort descending 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.
MigrateImportEvent::$migration protected property Migration entity.
MigrateImportEvent::getMigration public function Gets the migration entity.
MigrateImportEvent::__construct public function Constructs an import event object.