class RejectionException

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

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

Hierarchy

Expanded class hierarchy of RejectionException

File

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

Namespace

GuzzleHttp\Promise
View source 
class RejectionException extends \RuntimeException {
    
    /** @var mixed Rejection reason. */
    private $reason;
    
    /**
     * @param mixed       $reason      Rejection reason.
     * @param string|null $description Optional description.
     */
    public function __construct($reason, ?string $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

Title Modifiers Object type Summary Overrides
RejectionException::$reason private property @var mixed Rejection reason.
RejectionException::getReason public function Returns the rejection reason.
RejectionException::__construct public function 1