annotate core/modules/migrate/src/Audit/HighestIdInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@14 1 <?php
Chris@14 2
Chris@14 3 namespace Drupal\migrate\Audit;
Chris@14 4
Chris@14 5 /**
Chris@14 6 * Defines an interface for destination and ID maps which track a highest ID.
Chris@14 7 *
Chris@14 8 * When implemented by destination plugins, getHighestId() should return the
Chris@14 9 * highest ID of the destination entity type that exists in the system. So, for
Chris@14 10 * example, the entity:node plugin should return the highest node ID that
Chris@14 11 * exists, regardless of whether it was created by a migration.
Chris@14 12 *
Chris@14 13 * When implemented by an ID map, getHighestId() should return the highest
Chris@14 14 * migrated ID of the destination entity type.
Chris@14 15 */
Chris@14 16 interface HighestIdInterface {
Chris@14 17
Chris@14 18 /**
Chris@14 19 * Returns the highest ID tracked by the implementing plugin.
Chris@14 20 *
Chris@14 21 * @return int
Chris@14 22 * The highest ID.
Chris@14 23 */
Chris@14 24 public function getHighestId();
Chris@14 25
Chris@14 26 }