class MigrateMapDeleteEvent in Zircon Profile 8

Wraps a migrate map delete event for event listeners.

Hierarchy

• class \Symfony\Component\EventDispatcher\Event
  • class \Drupal\migrate\Event\MigrateMapDeleteEvent

2 files declare their use of MigrateMapDeleteEvent

MigrateEventsTest.php in core/modules/migrate/src/Tests/MigrateEventsTest.php

Contains \Drupal\migrate\Tests\MigrateEventsTest.

Sql.php in core/modules/migrate/src/Plugin/migrate/id_map/Sql.php

Contains \Drupal\migrate\Plugin\migrate\id_map\Sql.

File

core/modules/migrate/src/Event/MigrateMapDeleteEvent.php, line 16

Contains \Drupal\migrate\Event\MigrateMapDeleteEvent.

Namespace

Drupal\migrate\Event

class MigrateMapDeleteEvent extends Event {

  /**
   * Map plugin.
   *
   * @var \Drupal\migrate\Plugin\MigrateIdMapInterface
   */
  protected $map;

  /**
   * Array of source ID fields.
   *
   * @var array
   */
  protected $sourceId;

  /**
   * Constructs a migration map delete event object.
   *
   * @param \Drupal\migrate\Plugin\MigrateIdMapInterface $map
   *   Map plugin.
   * @param array $source_id
   *   Array of source ID fields representing the object being deleted from the map.
   */
  public function __construct(MigrateIdMapInterface $map, array $source_id) {
    $this->map = $map;
    $this->sourceId = $source_id;
  }

  /**
   * 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 source ID of the item being removed from the map.
   *
   * @return array
   *   Array of source ID fields.
   */
  public function getSourceId() {
    return $this->sourceId;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Event::$dispatcher	private	property
Event::$name	private	property
Event::$propagationStopped	private	property
Event::getDispatcher Deprecated	public	function	Returns the EventDispatcher that dispatches this Event.
Event::getName Deprecated	public	function	Gets the event's name.
Event::isPropagationStopped	public	function	Returns whether further event listeners should be triggered.
Event::setDispatcher Deprecated	public	function	Stores the EventDispatcher that dispatches this Event.
Event::setName Deprecated	public	function	Sets the event's name property.
Event::stopPropagation	public	function	Stops the propagation of the event to further event listeners.
MigrateMapDeleteEvent::$map	protected	property	Map plugin.
MigrateMapDeleteEvent::$sourceId	protected	property	Array of source ID fields.
MigrateMapDeleteEvent::getMap	public	function	Gets the map plugin.
MigrateMapDeleteEvent::getSourceId	public	function	Gets the source ID of the item being removed from the map.
MigrateMapDeleteEvent::__construct	public	function	Constructs a migration map delete event object.