class RequirementsException
Same name in other branches
- 9 core/modules/migrate/src/Exception/RequirementsException.php \Drupal\migrate\Exception\RequirementsException
- 8.9.x core/modules/migrate/src/Exception/RequirementsException.php \Drupal\migrate\Exception\RequirementsException
- 11.x core/modules/migrate/src/Exception/RequirementsException.php \Drupal\migrate\Exception\RequirementsException
Defines an exception thrown when a migration does not meet the requirements.
Hierarchy
- class \Drupal\migrate\Exception\RequirementsException extends \Drupal\migrate\Exception\RuntimeException
Expanded class hierarchy of RequirementsException
See also
\Drupal\migrate\Plugin\RequirementsInterface
33 files declare their use of RequirementsException
- CheckRequirementsTest.php in core/
modules/ migrate/ tests/ src/ Unit/ Plugin/ migrate/ destination/ CheckRequirementsTest.php - CommentEntityTranslation.php in core/
modules/ comment/ src/ Plugin/ migrate/ source/ d7/ CommentEntityTranslation.php - CommentEntityTranslationCheckRequirementsTest.php in core/
modules/ comment/ tests/ src/ Kernel/ Migrate/ d7/ CommentEntityTranslationCheckRequirementsTest.php - CommentType.php in core/
modules/ comment/ src/ Plugin/ migrate/ source/ CommentType.php - CommentTypeRequirementsTest.php in core/
modules/ comment/ tests/ src/ Kernel/ Plugin/ migrate/ source/ CommentTypeRequirementsTest.php
File
-
core/
modules/ migrate/ src/ Exception/ RequirementsException.php, line 10
Namespace
Drupal\migrate\ExceptionView source
class RequirementsException extends \RuntimeException {
/**
* The missing requirements.
*
* @var array
*/
protected $requirements;
/**
* Constructs a new RequirementsException instance.
*
* @param string $message
* (optional) The Exception message to throw.
* @param array $requirements
* (optional) The missing requirements.
* @param int $code
* (optional) The Exception code.
* @param \Exception $previous
* (optional) The previous exception used for the exception chaining.
*/
public function __construct($message = "", array $requirements = [], $code = 0, ?\Exception $previous = NULL) {
parent::__construct($message, $code, $previous);
$this->requirements = $requirements;
}
/**
* Get an array of requirements.
*
* @return array
* The requirements.
*/
public function getRequirements() {
return $this->requirements;
}
/**
* Get the requirements as a string.
*
* @return string
* A formatted requirements string.
*/
public function getRequirementsString() {
$output = '';
foreach ($this->requirements as $requirement_type => $requirements) {
if (!is_array($requirements)) {
$requirements = [
$requirements,
];
}
foreach ($requirements as $value) {
$output .= "{$requirement_type}: {$value}. ";
}
}
return trim($output);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
RequirementsException::$requirements | protected | property | The missing requirements. |
RequirementsException::getRequirements | public | function | Get an array of requirements. |
RequirementsException::getRequirementsString | public | function | Get the requirements as a string. |
RequirementsException::__construct | public | function | Constructs a new RequirementsException instance. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.