Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. ParseException.php

class ParseException

Same name in this branch
  1. 11.1.x vendor/symfony/css-selector/Exception/ParseException.php \Symfony\Component\CssSelector\Exception\ParseException

Exception class thrown when an error occurs during parsing.

@author Fabien Potencier <fabien@symfony.com>

Hierarchy

  • class \Symfony\Component\Yaml\Exception\RuntimeException extends \Symfony\Component\Yaml\Exception\RuntimeException implements \Symfony\Component\Yaml\Exception\ExceptionInterface
    • class \Symfony\Component\Yaml\Exception\RuntimeException extends \Symfony\Component\Yaml\Exception\RuntimeException implements \Symfony\Component\Yaml\Exception\ExceptionInterface
      • class \Symfony\Component\Yaml\Exception\ParseException extends \Symfony\Component\Yaml\Exception\RuntimeException

Expanded class hierarchy of ParseException

14 files declare their use of ParseException
CoreVersionRequirementSniff.php in vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/CoreVersionRequirementSniff.php
DependenciesArraySniff.php in vendor/drupal/coder/coder_sniffer/Drupal/Sniffs/InfoFiles/DependenciesArraySniff.php
DescriptionSniff.php in vendor/drupal/coder/coder_sniffer/DrupalPractice/Sniffs/InfoFiles/DescriptionSniff.php
FailureMarker.php in core/modules/package_manager/src/FailureMarker.php
Inline.php in vendor/symfony/yaml/Inline.php

... See full list

File

vendor/symfony/yaml/Exception/ParseException.php, line 19

Namespace

Symfony\Component\Yaml\Exception
View source
class ParseException extends RuntimeException {
    
    /**
     * @param string      $rawMessage The error message
     * @param int         $parsedLine The line where the error occurred
     * @param string|null $snippet    The snippet of code near the problem
     * @param string|null $parsedFile The file name where the error occurred
     */
    public function __construct(string $rawMessage, int $parsedLine = -1, ?string $snippet = null, ?string $parsedFile = null, ?\Throwable $previous = null) {
        $this->updateRepr();
        parent::__construct($this->message, 0, $previous);
    }
    
    /**
     * Gets the snippet of code near the error.
     */
    public function getSnippet() : string {
        return $this->snippet;
    }
    
    /**
     * Sets the snippet of code near the error.
     */
    public function setSnippet(string $snippet) : void {
        $this->snippet = $snippet;
        $this->updateRepr();
    }
    
    /**
     * Gets the filename where the error occurred.
     *
     * This method returns null if a string is parsed.
     */
    public function getParsedFile() : string {
        return $this->parsedFile;
    }
    
    /**
     * Sets the filename where the error occurred.
     */
    public function setParsedFile(string $parsedFile) : void {
        $this->parsedFile = $parsedFile;
        $this->updateRepr();
    }
    
    /**
     * Gets the line where the error occurred.
     */
    public function getParsedLine() : int {
        return $this->parsedLine;
    }
    
    /**
     * Sets the line where the error occurred.
     */
    public function setParsedLine(int $parsedLine) : void {
        $this->parsedLine = $parsedLine;
        $this->updateRepr();
    }
    private function updateRepr() : void {
        $this->message = $this->rawMessage;
        $dot = false;
        if (str_ends_with($this->message, '.')) {
            $this->message = substr($this->message, 0, -1);
            $dot = true;
        }
        if (null !== $this->parsedFile) {
            $this->message .= \sprintf(' in %s', json_encode($this->parsedFile, \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE));
        }
        if ($this->parsedLine >= 0) {
            $this->message .= \sprintf(' at line %d', $this->parsedLine);
        }
        if ($this->snippet) {
            $this->message .= \sprintf(' (near "%s")', $this->snippet);
        }
        if ($dot) {
            $this->message .= '.';
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary
ParseException::getParsedFile public function Gets the filename where the error occurred.
ParseException::getParsedLine public function Gets the line where the error occurred.
ParseException::getSnippet public function Gets the snippet of code near the error.
ParseException::setParsedFile public function Sets the filename where the error occurred.
ParseException::setParsedLine public function Sets the line where the error occurred.
ParseException::setSnippet public function Sets the snippet of code near the error.
ParseException::updateRepr private function
ParseException::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal