class RecipeFileException

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Recipe/RecipeFileException.php \Drupal\Core\Recipe\RecipeFileException

@internal This API is experimental.

Hierarchy

Expanded class hierarchy of RecipeFileException

3 files declare their use of RecipeFileException
ConfigActionValidationTest.php in core/tests/Drupal/KernelTests/Core/Recipe/ConfigActionValidationTest.php
RecipeTest.php in core/tests/Drupal/KernelTests/Core/Recipe/RecipeTest.php
RecipeValidationTest.php in core/tests/Drupal/KernelTests/Core/Recipe/RecipeValidationTest.php

File

core/lib/Drupal/Core/Recipe/RecipeFileException.php, line 13

Namespace

Drupal\Core\Recipe
View source 
final class RecipeFileException extends \RuntimeException {
    
    /**
     * Constructs a RecipeFileException object.
     *
     * @param string $path
     *   The path of the offending recipe file.
     * @param string $message
     *   (optional) The exception message.
     * @param \Symfony\Component\Validator\ConstraintViolationList|null $violations
     *   (optional) A list of validation constraint violations in the recipe file,
     *   if any.
     * @param int $code
     *   (optional) The exception code.
     * @param \Throwable|null $previous
     *   (optional) The previous exception, if any.
     */
    public function __construct(string $path, string $message = '', ?ConstraintViolationList $violations = NULL, int $code = 0, ?\Throwable $previous = NULL) {
        parent::__construct($message, $code, $previous);
    }
    
    /**
     * Creates an instance of this exception from a set of validation errors.
     *
     * @param string $path
     *   The path of the offending recipe file.
     * @param \Symfony\Component\Validator\ConstraintViolationList $violations
     *   The list of validation constraint violations.
     *
     * @return static
     */
    public static function fromViolationList(string $path, ConstraintViolationList $violations) : static {
        $lines = [
            "Validation errors were found in {$path}:",
        ];
        foreach ($violations as $violation) {
            $lines[] = sprintf('- %s: %s', $violation->getPropertyPath(), $violation->getMessage());
        }
        return new static($path, implode("\n", $lines), $violations);
    }

}

Members

Title Modifiers Object type Summary
RecipeFileException::fromViolationList public static function Creates an instance of this exception from a set of validation errors.
RecipeFileException::__construct public function Constructs a RecipeFileException object.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.