MigrateMapSaveEvent.php

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

Namespace

Drupal\migrate\Event

File

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

View source
<?php

namespace Drupal\migrate\Event;

use Drupal\migrate\Plugin\MigrateIdMapInterface;
use Drupal\Component\EventDispatcher\Event;

/**
 * Wraps a migrate map save event for event listeners.
 */
class MigrateMapSaveEvent extends Event {
    
    /**
     * Map plugin.
     *
     * @var \Drupal\migrate\Plugin\MigrateIdMapInterface
     */
    protected $map;
    
    /**
     * Array of fields being saved to the map, keyed by field name.
     *
     * @var array
     */
    protected $fields;
    
    /**
     * Constructs a migration map event object.
     *
     * @param \Drupal\migrate\Plugin\MigrateIdMapInterface $map
     *   Map plugin.
     * @param array $fields
     *   Array of fields being saved to the map.
     */
    public function __construct(MigrateIdMapInterface $map, array $fields) {
        $this->map = $map;
        $this->fields = $fields;
    }
    
    /**
     * Gets the map plugin.
     *
     * @return \Drupal\migrate\Plugin\MigrateIdMapInterface
     *   The map plugin that caused the event to fire.
     */
    public function getMap() {
        return $this->map;
    }
    
    /**
     * Gets the fields about to be saved to the map.
     *
     * @return array
     *   Array of map fields, keyed by field name.
     */
    public function getFields() {
        return $this->fields;
    }

}

Classes

Title Deprecated Summary
MigrateMapSaveEvent Wraps a migrate map save event for event listeners.

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