interface HighestIdInterface

Same name in other branches
  1. 9 core/modules/migrate/src/Audit/HighestIdInterface.php \Drupal\migrate\Audit\HighestIdInterface
  2. 8.9.x core/modules/migrate/src/Audit/HighestIdInterface.php \Drupal\migrate\Audit\HighestIdInterface
  3. 10 core/modules/migrate/src/Audit/HighestIdInterface.php \Drupal\migrate\Audit\HighestIdInterface

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

Expanded class hierarchy of HighestIdInterface

All classes that implement 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
View source 
interface HighestIdInterface {
    
    /**
     * Returns the highest ID tracked by the implementing plugin.
     *
     * @return int
     *   The highest ID.
     */
    public function getHighestId();

}

Members

Title Modifiers Object type Summary Overrides
HighestIdInterface::getHighestId public function Returns the highest ID tracked by the implementing plugin. 2

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