www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/migrate/src/Audit/HighestIdInterface.php

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