class MockHandler in Auth0 Single Sign On 8.2

Handler that returns responses or throw exceptions from a queue.

Hierarchy

• class \GuzzleHttp\Handler\MockHandler implements \GuzzleHttp\Handler\Countable

4 files declare their use of MockHandler

Auth0Test.php in vendor/auth0/auth0-php/tests/Auth0Test.php

MockApi.php in vendor/auth0/auth0-php/tests/MockApi.php

MockManagementApi.php in vendor/auth0/auth0-php/tests/API/Management/MockManagementApi.php

RequestBuilderTest.php in vendor/auth0/auth0-php/tests/API/Helpers/RequestBuilderTest.php

File

vendor/guzzlehttp/guzzle/src/Handler/MockHandler.php, line 15

Namespace

GuzzleHttp\Handler

class MockHandler implements \Countable {
  private $queue = [];
  private $lastRequest;
  private $lastOptions;
  private $onFulfilled;
  private $onRejected;

  /**
   * Creates a new MockHandler that uses the default handler stack list of
   * middlewares.
   *
   * @param array $queue Array of responses, callables, or exceptions.
   * @param callable $onFulfilled Callback to invoke when the return value is fulfilled.
   * @param callable $onRejected  Callback to invoke when the return value is rejected.
   *
   * @return HandlerStack
   */
  public static function createWithMiddleware(array $queue = null, callable $onFulfilled = null, callable $onRejected = null) {
    return HandlerStack::create(new self($queue, $onFulfilled, $onRejected));
  }

  /**
   * The passed in value must be an array of
   * {@see Psr7\Http\Message\ResponseInterface} objects, Exceptions,
   * callables, or Promises.
   *
   * @param array $queue
   * @param callable $onFulfilled Callback to invoke when the return value is fulfilled.
   * @param callable $onRejected  Callback to invoke when the return value is rejected.
   */
  public function __construct(array $queue = null, callable $onFulfilled = null, callable $onRejected = null) {
    $this->onFulfilled = $onFulfilled;
    $this->onRejected = $onRejected;
    if ($queue) {
      call_user_func_array([
        $this,
        'append',
      ], $queue);
    }
  }
  public function __invoke(RequestInterface $request, array $options) {
    if (!$this->queue) {
      throw new \OutOfBoundsException('Mock queue is empty');
    }
    if (isset($options['delay']) && is_numeric($options['delay'])) {
      usleep($options['delay'] * 1000);
    }
    $this->lastRequest = $request;
    $this->lastOptions = $options;
    $response = array_shift($this->queue);
    if (isset($options['on_headers'])) {
      if (!is_callable($options['on_headers'])) {
        throw new \InvalidArgumentException('on_headers must be callable');
      }
      try {
        $options['on_headers']($response);
      } catch (\Exception $e) {
        $msg = 'An error was encountered during the on_headers event';
        $response = new RequestException($msg, $request, $response, $e);
      }
    }
    if (is_callable($response)) {
      $response = call_user_func($response, $request, $options);
    }
    $response = $response instanceof \Exception ? \GuzzleHttp\Promise\rejection_for($response) : \GuzzleHttp\Promise\promise_for($response);
    return $response
      ->then(function ($value) use ($request, $options) {
      $this
        ->invokeStats($request, $options, $value);
      if ($this->onFulfilled) {
        call_user_func($this->onFulfilled, $value);
      }
      if (isset($options['sink'])) {
        $contents = (string) $value
          ->getBody();
        $sink = $options['sink'];
        if (is_resource($sink)) {
          fwrite($sink, $contents);
        }
        elseif (is_string($sink)) {
          file_put_contents($sink, $contents);
        }
        elseif ($sink instanceof \Psr\Http\Message\StreamInterface) {
          $sink
            ->write($contents);
        }
      }
      return $value;
    }, function ($reason) use ($request, $options) {
      $this
        ->invokeStats($request, $options, null, $reason);
      if ($this->onRejected) {
        call_user_func($this->onRejected, $reason);
      }
      return \GuzzleHttp\Promise\rejection_for($reason);
    });
  }

  /**
   * Adds one or more variadic requests, exceptions, callables, or promises
   * to the queue.
   */
  public function append() {
    foreach (func_get_args() as $value) {
      if ($value instanceof ResponseInterface || $value instanceof \Exception || $value instanceof PromiseInterface || is_callable($value)) {
        $this->queue[] = $value;
      }
      else {
        throw new \InvalidArgumentException('Expected a response or ' . 'exception. Found ' . \GuzzleHttp\describe_type($value));
      }
    }
  }

  /**
   * Get the last received request.
   *
   * @return RequestInterface
   */
  public function getLastRequest() {
    return $this->lastRequest;
  }

  /**
   * Get the last received request options.
   *
   * @return array
   */
  public function getLastOptions() {
    return $this->lastOptions;
  }

  /**
   * Returns the number of remaining items in the queue.
   *
   * @return int
   */
  public function count() {
    return count($this->queue);
  }
  public function reset() {
    $this->queue = [];
  }
  private function invokeStats(RequestInterface $request, array $options, ResponseInterface $response = null, $reason = null) {
    if (isset($options['on_stats'])) {
      $transferTime = isset($options['transfer_time']) ? $options['transfer_time'] : 0;
      $stats = new TransferStats($request, $response, $transferTime, $reason);
      call_user_func($options['on_stats'], $stats);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MockHandler::$lastOptions	private	property
MockHandler::$lastRequest	private	property
MockHandler::$onFulfilled	private	property
MockHandler::$onRejected	private	property
MockHandler::$queue	private	property
MockHandler::append	public	function	Adds one or more variadic requests, exceptions, callables, or promises to the queue.
MockHandler::count	public	function	Returns the number of remaining items in the queue.
MockHandler::createWithMiddleware	public static	function	Creates a new MockHandler that uses the default handler stack list of middlewares.
MockHandler::getLastOptions	public	function	Get the last received request options.
MockHandler::getLastRequest	public	function	Get the last received request.
MockHandler::invokeStats	private	function
MockHandler::reset	public	function
MockHandler::__construct	public	function	The passed in value must be an array of {callables, or Promises.
MockHandler::__invoke	public	function