You are here

class RejectionException in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/guzzlehttp/promises/src/RejectionException.php \GuzzleHttp\Promise\RejectionException

A special exception that is thrown when waiting on a rejected promise.

The reason value is available via the getReason() method.

Hierarchy

  • class \GuzzleHttp\Promise\RejectionException extends \GuzzleHttp\Promise\RuntimeException

Expanded class hierarchy of RejectionException

2 files declare their use of RejectionException
PromiseTest.php in vendor/guzzlehttp/promises/tests/PromiseTest.php
RejectionExceptionTest.php in vendor/guzzlehttp/promises/tests/RejectionExceptionTest.php

File

vendor/guzzlehttp/promises/src/RejectionException.php, line 9

Namespace

GuzzleHttp\Promise
View source
class RejectionException extends \RuntimeException {

  /** @var mixed Rejection reason. */
  private $reason;

  /**
   * @param mixed $reason       Rejection reason.
   * @param string $description Optional description
   */
  public function __construct($reason, $description = null) {
    $this->reason = $reason;
    $message = 'The promise was rejected';
    if ($description) {
      $message .= ' with reason: ' . $description;
    }
    elseif (is_string($reason) || is_object($reason) && method_exists($reason, '__toString')) {
      $message .= ' with reason: ' . $this->reason;
    }
    elseif ($reason instanceof \JsonSerializable) {
      $message .= ' with reason: ' . json_encode($this->reason, JSON_PRETTY_PRINT);
    }
    parent::__construct($message);
  }

  /**
   * Returns the rejection reason.
   *
   * @return mixed
   */
  public function getReason() {
    return $this->reason;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
RejectionException::$reason private property @var mixed Rejection reason.
RejectionException::getReason public function Returns the rejection reason.
RejectionException::__construct public function 1