interface AuditorInterface

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

Defines an interface for migration auditors.

A migration auditor is a class which can examine a migration to determine if it will cause conflicts with data already existing in the destination system. What kind of auditing it does, and how it does it, is up to the implementing class.

Hierarchy

Expanded class hierarchy of AuditorInterface

All classes that implement AuditorInterface

File

core/modules/migrate/src/Audit/AuditorInterface.php, line 15

Namespace

Drupal\migrate\Audit
View source 
interface AuditorInterface {
    
    /**
     * Audits a migration.
     *
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   The migration to audit.
     *
     * @throws \Drupal\migrate\Audit\AuditException
     *   If the audit fails.
     *
     * @return \Drupal\migrate\Audit\AuditResult
     *   The result of the audit.
     */
    public function audit(MigrationInterface $migration);
    
    /**
     * Audits a set of migrations.
     *
     * @param \Drupal\migrate\Plugin\MigrationInterface[] $migrations
     *   The migrations to audit.
     *
     * @return \Drupal\migrate\Audit\AuditResult[]
     *   The audit results, keyed by migration ID.
     */
    public function auditMultiple(array $migrations);

}

Members

Title Modifiers Object type Summary Overrides
AuditorInterface::audit public function Audits a migration. 1
AuditorInterface::auditMultiple public function Audits a set of migrations. 1

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