MigratePreRowSaveEvent.php

Same filename in other branches
  1. 8.9.x core/modules/migrate/src/Event/MigratePreRowSaveEvent.php
  2. 10 core/modules/migrate/src/Event/MigratePreRowSaveEvent.php
  3. 11.x core/modules/migrate/src/Event/MigratePreRowSaveEvent.php

Namespace

Drupal\migrate\Event

File

core/modules/migrate/src/Event/MigratePreRowSaveEvent.php

View source
<?php

namespace Drupal\migrate\Event;

use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\MigrateMessageInterface;
use Drupal\migrate\Row;

/**
 * Wraps a pre-save event for event listeners.
 */
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;
    }

}

Classes

Title Deprecated Summary
MigratePreRowSaveEvent Wraps a pre-save event for event listeners.

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