ParamNotConvertedException.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/ParamConverter/ParamNotConvertedException.php
  2. 8.9.x core/lib/Drupal/Core/ParamConverter/ParamNotConvertedException.php
  3. 10 core/lib/Drupal/Core/ParamConverter/ParamNotConvertedException.php

Namespace

Drupal\Core\ParamConverter

File

core/lib/Drupal/Core/ParamConverter/ParamNotConvertedException.php

View source
<?php

namespace Drupal\Core\ParamConverter;


/**
 * Provides an exception class for a request parameter that was not converted.
 */
class ParamNotConvertedException extends \Exception {
  
  /**
   * The route name that was not converted.
   *
   * @var string
   */
  protected $routeName = "";
  
  /**
   * The raw parameters that were not converted.
   *
   * @var array
   */
  protected $rawParameters = [];
  
  /**
   * Constructs the ParamNotConvertedException.
   *
   * @param string $message
   *   The Exception message to throw.
   * @param int $code
   *   The Exception code.
   * @param \Throwable $previous
   *   The previous exception used for the exception chaining.
   * @param string $route_name
   *   The route name that was not converted.
   * @param array $raw_parameters
   *   The raw parameters that were not converted.
   */
  public function __construct($message = "", $code = 0, ?\Throwable $previous = NULL, $route_name = "", array $raw_parameters = []) {
    parent::__construct($message, $code, $previous);
    $this->routeName = $route_name;
    $this->rawParameters = $raw_parameters;
  }
  
  /**
   * Get the route name that was not converted.
   *
   * @return string
   *   The route name that was not converted.
   */
  public function getRouteName() {
    return $this->routeName;
  }
  
  /**
   * Get the raw parameters that were not converted.
   *
   * @return array
   *   The raw parameters that were not converted.
   */
  public function getRawParameters() {
    return $this->rawParameters;
  }

}

Classes

Title Deprecated Summary
ParamNotConvertedException Provides an exception class for a request parameter that was not converted.

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