HttpRedirectionStatus

Since v2.0.0

Description

HttpRedirectionStatus is an interface. It is implemented by all of the HTTP status value objects that represent a HTTP 3xx status code.

Public Interface

// HttpRedirectionStatus lives in this namespace
namespace GanbaroDigital\HttpStatus\Interfaces;

// our base interfaces
use GanbaroDigital\HttpStatus\Interfaces\HttpStatus;

interface HttpRedirectionStatus extends HttpStatus
{
    /**
     * constructs a new HttpStatus value object
     *
     * @param int $code
     *        the HTTP status code to use
     * @param string $reasonPhrase
     *        the HTTP reason-phrase to use
     * @inheritedFrom HttpStatus
     */
    public function __construct($statusCode, $reasonPhrase);

    /**
     * returns the HTTP status code
     *
     * @return int
     * @inheritedFrom HttpStatus
     */
    public function getStatusCode();

    /**
     * returns the HTTP status reason-phrase
     *
     * @return string
     * @inheritedFrom HttpStatus
     */
    public function getReasonPhrase();

    /**
     * returns the HTTP status line
     *
     * this is code + ' ' + reason-phrase
     *
     * @return string
     * @inheritedFrom HttpStatus
     */
    public function getStatusLine();
}

How To Use

HTTP Status Value Objects

Implement HttpRedirectionStatus on any value objects that represent HTTP 3xx status codes.

Type-Hinting

Use HttpRedirectionStatus as a type-hint for any functions and methods that accept or return HTTP 3xx status value objects.

Notes

None at this time.