class MarkdownUnexpectedValueException in Markdown 8.2

Hierarchy

• class \Drupal\markdown\Exception\MarkdownUnexpectedValueException extends \Drupal\markdown\Exception\UnexpectedValueException implements MarkdownExceptionInterface

2 files declare their use of MarkdownUnexpectedValueException

InstallablePluginManager.php in src/PluginManager/InstallablePluginManager.php

NormalizeTrait.php in src/Traits/NormalizeTrait.php

File

src/Exception/MarkdownUnexpectedValueException.php, line 5

Namespace

Drupal\markdown\Exception

class MarkdownUnexpectedValueException extends \UnexpectedValueException implements MarkdownExceptionInterface {

  /**
   * Known key, if value is in an array or Traversable object.
   *
   * @var int|string
   */
  protected $key;

  /**
   * Know parents, if value is nested inside an array or Traversable object.
   *
   * @var array
   */
  protected $parents = [];

  /**
   * The unexpected value.
   *
   * @var mixed
   */
  protected $value;

  /**
   * Creates a new instance of the exception.
   *
   * @param mixed $value
   *   The unexpected value.
   * @param string|int $key
   *   Known key, if value is in an array or Traversable object.
   * @param array $parents
   *   Know parents, if value is nested inside an array or Traversable object.
   * @param \Throwable $previous
   *   A previous exception, if rethrown.
   * @param string[] $templates
   *   An indexed array of templates to be used depending on whether there is
   *   known hierarchy (i.e. if $key and/or $parents were provided):
   *   - (string) No hierarchy known. Only a single variable (%s) will be
   *     replaced with the unexpected value.
   *   - (string) Hierarchy known. Two variables (%s) will be passed, the first
   *     is the unexpected value and the second is the full path in dot'
   *     notation, constructed from passed $key and $parents.
   */
  public function __construct($value, $key = NULL, array $parents = [], $previous = NULL, array $templates = []) {
    $this->value = $value;
    $this->key = $key;
    $this->parents = $parents;
    list($message, $messageHierarchy) = $templates + [
      'Unexpected value "%s".',
      'Unexpected value "%s" set at %s.',
    ];
    if (isset($this->key)) {
      $name = $this->key;
      if ($this->parents) {
        $name = implode('.', $parents) . ".{$name}";
      }
      $message = sprintf($messageHierarchy, $value, $name);
    }
    else {
      $message = sprintf($message, $value);
    }
    parent::__construct($message, 0, $previous);
  }

  /**
   * Retrieves the known key, if value is in an array or Traversable object.
   *
   * @return string|int|null
   *   The known key, if any.
   */
  public function getKey() {
    return $this->key;
  }

  /**
   * Retrieves the know parents, if value was nested.
   *
   * @return array
   *   The known parents, if any.
   */
  public function getParents() {
    return $this->parents;
  }

  /**
   * The unexpected value.
   *
   * @return mixed
   *   The unexpected value.
   */
  public function getValue() {
    return $this->value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MarkdownUnexpectedValueException::$key	protected	property	Known key, if value is in an array or Traversable object.
MarkdownUnexpectedValueException::$parents	protected	property	Know parents, if value is nested inside an array or Traversable object.
MarkdownUnexpectedValueException::$value	protected	property	The unexpected value.
MarkdownUnexpectedValueException::getKey	public	function	Retrieves the known key, if value is in an array or Traversable object.
MarkdownUnexpectedValueException::getParents	public	function	Retrieves the know parents, if value was nested.
MarkdownUnexpectedValueException::getValue	public	function	The unexpected value.
MarkdownUnexpectedValueException::__construct	public	function	Creates a new instance of the exception.