class EntityValidationException
Same name in other branches
- 9 core/modules/migrate/src/Exception/EntityValidationException.php \Drupal\migrate\Exception\EntityValidationException
- 8.9.x core/modules/migrate/src/Exception/EntityValidationException.php \Drupal\migrate\Exception\EntityValidationException
- 11.x core/modules/migrate/src/Exception/EntityValidationException.php \Drupal\migrate\Exception\EntityValidationException
To throw when an entity generated during the import is not valid.
Hierarchy
- class \Drupal\migrate\MigrateException extends \Drupal\migrate\Exception
- class \Drupal\migrate\Exception\EntityValidationException extends \Drupal\migrate\MigrateException
Expanded class hierarchy of EntityValidationException
1 file declares its use of EntityValidationException
- EntityContentBase.php in core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ EntityContentBase.php
File
-
core/
modules/ migrate/ src/ Exception/ EntityValidationException.php, line 13
Namespace
Drupal\migrate\ExceptionView source
class EntityValidationException extends MigrateException {
/**
* The separator for combining multiple messages into a single string.
*
* Afterwards, the separator could be used to split a concatenated string
* onto multiple lines.
*
* @code
* explode(EntityValidationException::MESSAGES_SEPARATOR, $messages);
* @endcode
*/
const MESSAGES_SEPARATOR = '||';
/**
* The list of violations generated during the entity validation.
*
* @var \Drupal\Core\Entity\EntityConstraintViolationListInterface
*/
protected $violations;
/**
* EntityValidationException constructor.
*
* @param \Drupal\Core\Entity\EntityConstraintViolationListInterface $violations
* The list of violations generated during the entity validation.
*/
public function __construct(EntityConstraintViolationListInterface $violations) {
$this->violations = $violations;
$entity = $this->violations
->getEntity();
$locator = $entity->getEntityTypeId();
if ($entity_id = $entity->id()) {
$locator = sprintf('%s: %s', $locator, $entity_id);
if ($entity instanceof RevisionableInterface && ($revision_id = $entity->getRevisionId())) {
$locator .= sprintf(', revision: %s', $revision_id);
}
}
// Example: "[user]: field_a=Violation 1., field_b=Violation 2.".
// Example: "[user: 1]: field_a=Violation 1., field_b=Violation 2.".
// Example: "[node: 19, revision: 12129]: field_a=Violation 1.".
parent::__construct(sprintf('[%s]: %s', $locator, implode(static::MESSAGES_SEPARATOR, $this->getViolationMessages())));
}
/**
* Returns the list of violation messages.
*
* @return string[]
* The list of violation messages.
*/
public function getViolationMessages() {
$messages = [];
foreach ($this->violations as $violation) {
assert($violation instanceof ConstraintViolationInterface);
$messages[] = sprintf('%s=%s', $violation->getPropertyPath(), $violation->getMessage());
}
return $messages;
}
/**
* Returns the list of violations generated during the entity validation.
*
* @return \Drupal\Core\Entity\EntityConstraintViolationListInterface
* The list of violations generated during the entity validation.
*/
public function getViolations() {
return $this->violations;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
EntityValidationException::$violations | protected | property | The list of violations generated during the entity validation. | |
EntityValidationException::getViolationMessages | public | function | Returns the list of violation messages. | |
EntityValidationException::getViolations | public | function | Returns the list of violations generated during the entity validation. | |
EntityValidationException::MESSAGES_SEPARATOR | constant | The separator for combining multiple messages into a single string. | ||
EntityValidationException::__construct | public | function | EntityValidationException constructor. | Overrides MigrateException::__construct |
MigrateException::$level | protected | property | The level of the error being reported. | |
MigrateException::$status | protected | property | The status to record in the map table for the current item. | |
MigrateException::getLevel | public | function | Gets the level. | |
MigrateException::getStatus | public | function | Gets the status of the current item. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.