Overview

Namespaces

  • Baguette
    • Application
    • Response
    • Serializer
    • Session
  • Overview
  • Namespace
  • Class
 1:  2:  3:  4:  5:  6:  7:  8:  9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 
<?php

namespace Baguette\Response;

/**
 * Redirect Response class
 *
 * @author    USAMI Kenta <tadsan@zonu.me>
 * @copyright 2016 Baguette HQ
 * @license   http://www.apache.org/licenses/LICENSE-2.0 Apache-2.0
 */
final class RedirectResponse implements ResponseInterface
{
    private static $REDIRECT_STATUS_CODES = [
        301, // Moved Permanently
        302, // Found
        303, // See Other
        307, // Temporary Redirect
        308, // Permanent Redirect
    ];

    /** @var string */
    private $location;
    /** @var array  */
    private $params;
    /** @var int */
    private $status_code;

    /**
     * @param string $location
     * @param array  $params
     * @param int    $status_code
     */
    public function __construct($location, array $params = [], $status_code = null)
    {
        $this->location    = $location;
        $this->params      = $params;
        $this->status_code = ($status_code === null) ? 302 : $status_code;

        if (in_array($status_code, self::$REDIRECT_STATUS_CODES, true)) {
            $this->status_code = $status_code;
        } else {
            new \DomainException("$status_code is unexpected HTTP status code for redirect.");
        }
    }

    /**
     * @return array[]
     */
    public function getResponseHeaders()
    {
        $location = $this->location;
        if ($this->params) {
            $location .= '?' . http_build_query($this->params);
        }

        return [
            'location' => [$location],
        ];
    }

    /**
     * @return int
     */
    public function getHttpStatusCode()
    {
        return $this->status_code;
    }

    /**
     * @return false
     */
    public function render(\Baguette\Application $_)
    {
        return false;
    }
}
ξ ^ω^)ξ < Baguette Not Framework API documentation generated by ApiGen