interface HighestIdInterface in Drupal 9

Defines an interface for destination and ID maps which track a highest ID.

When implemented by destination plugins, getHighestId() should return the highest ID of the destination entity type that exists in the system. So, for example, the entity:node plugin should return the highest node ID that exists, regardless of whether it was created by a migration.

When implemented by an ID map, getHighestId() should return the highest migrated ID of the destination entity type.

Hierarchy

• interface \Drupal\migrate\Audit\HighestIdInterface

2 files declare their use of HighestIdInterface

EntityContentBase.php in core/modules/migrate/src/Plugin/migrate/destination/EntityContentBase.php

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

File

core/modules/migrate/src/Audit/HighestIdInterface.php, line 16

Namespace

Drupal\migrate\Audit

interface HighestIdInterface {

  /**
   * Returns the highest ID tracked by the implementing plugin.
   *
   * @return int
   *   The highest ID.
   */
  public function getHighestId();

}

Members

Name	Modifiers	Type	Description	Overrides
HighestIdInterface::getHighestId	public	function	Returns the highest ID tracked by the implementing plugin.	2