Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\migrate\Exception;
Chris@0: 
Chris@0: use Exception;
Chris@0: 
Chris@0: /**
Chris@14:  * Defines an exception thrown when a migration does not meet the requirements.
Chris@0:  *
Chris@0:  * @see \Drupal\migrate\Plugin\RequirementsInterface
Chris@0:  */
Chris@0: class RequirementsException extends \RuntimeException {
Chris@0: 
Chris@0:   /**
Chris@0:    * The missing requirements.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $requirements;
Chris@0: 
Chris@0:   /**
Chris@0:    * Constructs a new RequirementsException instance.
Chris@0:    *
Chris@0:    * @param string $message
Chris@0:    *   (optional) The Exception message to throw.
Chris@0:    * @param array $requirements
Chris@0:    *   (optional) The missing requirements.
Chris@0:    * @param int $code
Chris@0:    *   (optional) The Exception code.
Chris@0:    * @param \Exception $previous
Chris@0:    *   (optional) The previous exception used for the exception chaining.
Chris@0:    */
Chris@0:   public function __construct($message = "", array $requirements = [], $code = 0, Exception $previous = NULL) {
Chris@0:     parent::__construct($message, $code, $previous);
Chris@0: 
Chris@0:     $this->requirements = $requirements;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Get an array of requirements.
Chris@0:    *
Chris@0:    * @return array
Chris@0:    *   The requirements.
Chris@0:    */
Chris@0:   public function getRequirements() {
Chris@0:     return $this->requirements;
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Get the requirements as a string.
Chris@0:    *
Chris@0:    * @return string
Chris@0:    *   A formatted requirements string.
Chris@0:    */
Chris@0:   public function getRequirementsString() {
Chris@0:     $output = '';
Chris@0:     foreach ($this->requirements as $requirement_type => $requirements) {
Chris@0:       if (!is_array($requirements)) {
Chris@0:         $requirements = [$requirements];
Chris@0:       }
Chris@0: 
Chris@0:       foreach ($requirements as $value) {
Chris@0:         $output .= "$requirement_type: $value. ";
Chris@0:       }
Chris@0:     }
Chris@0:     return trim($output);
Chris@0:   }
Chris@0: 
Chris@0: }