MigrateRollbackEvent.php

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

Namespace

Drupal\migrate\Event

File

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

View source
<?php

namespace Drupal\migrate\Event;

use Drupal\migrate\Plugin\MigrationInterface;
use Symfony\Component\EventDispatcher\Event;

/**
 * Wraps a pre- or post-rollback event for event listeners.
 */
class MigrateRollbackEvent extends Event {
    
    /**
     * Migration entity.
     *
     * @var \Drupal\migrate\Plugin\MigrationInterface
     */
    protected $migration;
    
    /**
     * Constructs an rollback event object.
     *
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   Migration entity.
     */
    public function __construct(MigrationInterface $migration) {
        $this->migration = $migration;
    }
    
    /**
     * Gets the migration entity.
     *
     * @return \Drupal\migrate\Plugin\MigrationInterface
     *   The migration entity involved.
     */
    public function getMigration() {
        return $this->migration;
    }

}

Classes

Title Deprecated Summary
MigrateRollbackEvent Wraps a pre- or post-rollback event for event listeners.

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