class EventBase

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Event/EventBase.php \Drupal\migrate\Event\EventBase
  2. 8.9.x core/modules/migrate/src/Event/EventBase.php \Drupal\migrate\Event\EventBase
  3. 11.x core/modules/migrate/src/Event/EventBase.php \Drupal\migrate\Event\EventBase

Hierarchy

Expanded class hierarchy of EventBase

2 files declare their use of EventBase
EventBaseTest.php in core/modules/migrate/tests/src/Unit/Event/EventBaseTest.php
NodeTranslationMigrateSubscriber.php in core/modules/node/src/EventSubscriber/NodeTranslationMigrateSubscriber.php

File

core/modules/migrate/src/Event/EventBase.php, line 9

Namespace

Drupal\migrate\Event
View on git.drupalcode.org
View source 
class EventBase extends Event {
  
  /**
   * The migration.
   *
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;
  
  /**
   * The current message service.
   *
   * @var \Drupal\migrate\MigrateMessageInterface
   */
  protected $message;
  
  /**
   * Constructs a Migrate event object.
   *
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration being run.
   * @param \Drupal\migrate\MigrateMessageInterface $message
   *   The Migrate message service.
   */
  public function __construct(MigrationInterface $migration, MigrateMessageInterface $message) {
    $this->migration = $migration;
    $this->message = $message;
  }
  
  /**
   * Gets the migration.
   *
   * @return \Drupal\migrate\Plugin\MigrationInterface
   *   The migration being run.
   */
  public function getMigration() {
    return $this->migration;
  }
  
  /**
   * Logs a message using the Migrate message service.
   *
   * @param string $message
   *   The message to log.
   * @param string $type
   *   The type of message, for example: status or warning.
   */
  public function logMessage($message, $type = 'status') {
    $this->message
      ->display($message, $type);
  }

}

Members

Title Modifiers Object type Summary 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.
EventBase::__construct public function Constructs a Migrate event object. 1

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