You are here

RedirectResponse.php in Zircon Profile 8

File

vendor/zendframework/zend-diactoros/src/Response/RedirectResponse.php
View source
<?php

/**
 * Zend Framework (http://framework.zend.com/)
 *
 * @see       http://github.com/zendframework/zend-diactoros for the canonical source repository
 * @copyright Copyright (c) 2015 Zend Technologies USA Inc. (http://www.zend.com)
 * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
 */
namespace Zend\Diactoros\Response;

use InvalidArgumentException;
use Psr\Http\Message\UriInterface;
use Zend\Diactoros\Response;
use Zend\Diactoros\Stream;

/**
 * Produce a redirect response.
 */
class RedirectResponse extends Response {

  /**
   * Create a redirect response.
   *
   * Produces a redirect response with a Location header and the given status
   * (302 by default).
   *
   * Note: this method overwrites the `location` $headers value.
   *
   * @param string|UriInterface $uri URI for the Location header.
   * @param int $status Integer status code for the redirect; 302 by default.
   * @param array $headers Array of headers to use at initialization.
   */
  public function __construct($uri, $status = 302, array $headers = []) {
    if (!is_string($uri) && !$uri instanceof UriInterface) {
      throw new InvalidArgumentException(sprintf('Uri provided to %s MUST be a string or Psr\\Http\\Message\\UriInterface instance; received "%s"', __CLASS__, is_object($uri) ? get_class($uri) : gettype($uri)));
    }
    $headers['location'] = [
      (string) $uri,
    ];
    parent::__construct('php://temp', $status, $headers);
  }

}

Classes

Namesort descending Description
RedirectResponse Produce a redirect response.