1. interface
  2. Drupal
  3. \
  4. migrate
  5. \
  6. Audit
  7. \
  8. AuditorInterface

AuditorInterface

interface AuditorInterface (View source)

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.

Methods

AuditResult
audit(MigrationInterface $migration)

Audits a migration.

AuditResult[]
auditMultiple(array $migrations)

Audits a set of migrations.

Details

at line 29
AuditResult audit(MigrationInterface $migration)

Audits a migration.

Parameters

MigrationInterface $migration

The migration to audit.

Return Value

AuditResult

The result of the audit.

Exceptions

AuditException

at line 40
AuditResult[] auditMultiple(array $migrations)

Audits a set of migrations.

Parameters

array $migrations

The migrations to audit.

Return Value

AuditResult[]

The audit results, keyed by migration ID.