class MigratePreRowSaveEvent

Wraps a pre-save event for event listeners.

Hierarchy

Expanded class hierarchy of MigratePreRowSaveEvent

3 files declare their use of MigratePreRowSaveEvent
MigrateEventsTest.php in core/modules/migrate/tests/src/Kernel/MigrateEventsTest.php
MigrateExecutable.php in core/modules/migrate/src/MigrateExecutable.php
MigratePreRowSaveEventTest.php in core/modules/migrate/tests/src/Unit/Event/MigratePreRowSaveEventTest.php

File

View on git.drupalcode.org

core/modules/migrate/src/Event/MigratePreRowSaveEvent.php, line 12

Namespace

Drupal\migrate\Event
View source 
class MigratePreRowSaveEvent extends EventBase {
  
  /**
   * Row object.
   *
   * @var \Drupal\migrate\Row
   */
  protected $row;
  
  /**
   * Constructs a pre-save event object.
   *
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   Migration entity.
   * @param \Drupal\migrate\MigrateMessageInterface $message
   *   The current migrate message service.
   * @param \Drupal\migrate\Row $row
   *   The current row.
   */
  public function __construct(MigrationInterface $migration, MigrateMessageInterface $message, Row $row) {
    parent::__construct($migration, $message);
    $this->row = $row;
  }
  
  /**
   * Gets the row object.
   *
   * @return \Drupal\migrate\Row
   *   The row object about to be imported.
   */
  public function getRow() {
    return $this->row;
  }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
EventBase::$message protected property The current message service.
EventBase::$migration protected property The migration.
EventBase::getMigration public function Gets the migration.
EventBase::logMessage public function Logs a message using the Migrate message service.
MigratePreRowSaveEvent::$row protected property Row object.
MigratePreRowSaveEvent::getRow public function Gets the row object.
MigratePreRowSaveEvent::__construct public function Constructs a pre-save event object. Overrides EventBase::__construct 1

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.