class AuditResult
Same name in other branches
- 9 core/modules/migrate/src/Audit/AuditResult.php \Drupal\migrate\Audit\AuditResult
- 8.9.x core/modules/migrate/src/Audit/AuditResult.php \Drupal\migrate\Audit\AuditResult
- 11.x core/modules/migrate/src/Audit/AuditResult.php \Drupal\migrate\Audit\AuditResult
Encapsulates the result of a migration audit.
Hierarchy
- class \Drupal\migrate\Audit\AuditResult implements \Drupal\Component\Render\MarkupInterface, \Drupal\migrate\Audit\Countable
Expanded class hierarchy of AuditResult
2 files declare their use of AuditResult
- MigrateDrupal6AuditIdsTest.php in core/
modules/ migrate_drupal/ tests/ src/ Kernel/ d6/ MigrateDrupal6AuditIdsTest.php - MigrateDrupal7AuditIdsTest.php in core/
modules/ migrate_drupal/ tests/ src/ Kernel/ d7/ MigrateDrupal7AuditIdsTest.php
File
-
core/
modules/ migrate/ src/ Audit/ AuditResult.php, line 11
Namespace
Drupal\migrate\AuditView source
class AuditResult implements MarkupInterface, \Countable {
/**
* The audited migration.
*
* @var \Drupal\migrate\Plugin\MigrationInterface
*/
protected $migration;
/**
* The result of the audit (TRUE if passed, FALSE otherwise).
*
* @var bool
*/
protected $status;
/**
* The reasons why the migration passed or failed the audit.
*
* @var string[]
*/
protected $reasons = [];
/**
* AuditResult constructor.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The audited migration.
* @param bool $status
* The result of the audit (TRUE if passed, FALSE otherwise).
* @param string[] $reasons
* (optional) The reasons why the migration passed or failed the audit.
*/
public function __construct(MigrationInterface $migration, $status, array $reasons = []) {
if (!is_bool($status)) {
throw new \InvalidArgumentException('Audit results must have a boolean status.');
}
$this->migration = $migration;
$this->status = $status;
array_walk($reasons, [
$this,
'addReason',
]);
}
/**
* Returns the audited migration.
*
* @return \Drupal\migrate\Plugin\MigrationInterface
* The audited migration.
*/
public function getMigration() {
return $this->migration;
}
/**
* Returns the boolean result of the audit.
*
* @return bool
* The result of the audit. TRUE if the migration passed the audit, FALSE
* otherwise.
*/
public function passed() {
return $this->status;
}
/**
* Adds a reason why the migration passed or failed the audit.
*
* @param string|object $reason
* The reason to add. Can be a string or a string-castable object.
*
* @return $this
*/
public function addReason($reason) {
array_push($this->reasons, (string) $reason);
return $this;
}
/**
* Creates a passing audit result for a migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The audited migration.
* @param string[] $reasons
* (optional) The reasons why the migration passed the audit.
*
* @return static
*/
public static function pass(MigrationInterface $migration, array $reasons = []) {
return new static($migration, TRUE, $reasons);
}
/**
* Creates a failing audit result for a migration.
*
* @param \Drupal\migrate\Plugin\MigrationInterface $migration
* The audited migration.
* @param array $reasons
* (optional) The reasons why the migration failed the audit.
*
* @return static
*/
public static function fail(MigrationInterface $migration, array $reasons = []) {
return new static($migration, FALSE, $reasons);
}
/**
* Implements \Countable::count() for Twig template compatibility.
*
* @return int
*
* @see \Drupal\Component\Render\MarkupInterface
*/
public function count() {
return count($this->reasons);
}
/**
* Returns the reasons the migration passed or failed, as a string.
*
* @return string
*
* @see \Drupal\Component\Render\MarkupInterface
*/
public function __toString() {
return implode("\n", $this->reasons);
}
/**
* Returns the reasons the migration passed or failed, for JSON serialization.
*
* @return string[]
*/
public function jsonSerialize() {
return $this->reasons;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
AuditResult::$migration | protected | property | The audited migration. | |
AuditResult::$reasons | protected | property | The reasons why the migration passed or failed the audit. | |
AuditResult::$status | protected | property | The result of the audit (TRUE if passed, FALSE otherwise). | |
AuditResult::addReason | public | function | Adds a reason why the migration passed or failed the audit. | |
AuditResult::count | public | function | Implements \Countable::count() for Twig template compatibility. | |
AuditResult::fail | public static | function | Creates a failing audit result for a migration. | |
AuditResult::getMigration | public | function | Returns the audited migration. | |
AuditResult::jsonSerialize | public | function | Returns the reasons the migration passed or failed, for JSON serialization. | |
AuditResult::pass | public static | function | Creates a passing audit result for a migration. | |
AuditResult::passed | public | function | Returns the boolean result of the audit. | |
AuditResult::__construct | public | function | AuditResult constructor. | |
AuditResult::__toString | public | function | Returns the reasons the migration passed or failed, as a string. | Overrides MarkupInterface::__toString |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.