AppserverIo\Psr\Servlet\Http\HttpServletResponseWrapper

Complexity

Total Complexity

31

Size/Duplication

Total Lines	361
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

9.32%

Importance

Changes

0

31 Methods

Rating	Name	Duplication	Size	Complexity
A	injectHttpResponse()	0	4	1
A	addCookie()	0	4	1
A	hasCookie()	0	4	1
A	getCookie()	0	4	1
A	setHeaders()	0	4	1
A	getHeaders()	0	4	1
A	addHeader()	0	4	1
A	getHeader()	0	4	1
A	getHeadersAsString()	0	4	1
A	removeHeader()	0	4	1
A	hasHeader()	0	4	1
A	getResponse()	0	4	1
A	getStatusCode()	0	4	1
A	getStatusReasonPhrase()	0	4	1
A	getVersion()	0	4	1
A	resetBodyStream()	0	4	1
A	setStatusCode()	0	4	1
A	appendBodyStream()	0	4	1
A	copyBodyStream()	0	4	1
A	getBodyContent()	0	4	1
A	getBodyStream()	0	4	1
A	getCookies()	0	4	1
A	getException()	0	4	1
A	getState()	0	4	1
A	hasException()	0	4	1
A	hasState()	0	4	1
A	redirect()	0	4	1
A	setBodyStream()	0	4	1
A	setException()	0	4	1
A	setState()	0	4	1
A	setStatusReasonPhrase()	0	4	1

<?php

/**
 * \AppserverIo\Psr\Servlet\Http\HttpServletResponseWrapper
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Psr\Servlet\Http;

use AppserverIo\Psr\HttpMessage\CookieInterface;
use AppserverIo\Psr\Servlet\ServletResponseWrapper;

/**
 * A Http servlet response implementation.
 *
 * @author    Tim Wagner <tw@appserver.io>
 * @copyright 2015 TechDivision GmbH <info@appserver.io>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io-psr/servlet
 * @link      http://www.appserver.io
 */
class HttpServletResponseWrapper extends ServletResponseWrapper implements HttpServletResponseInterface
{

    /**
     * Injects the passed response instance into this servlet response.
     *
     * @param \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface $response The response instance used for initialization
     *
     * @return void
     */
    public function injectHttpResponse(HttpServletResponseInterface $response)
    {
        $this->injectResponse($response);
    }

    /**
     * Adds a cookie.
     *
     * @param \AppserverIo\Psr\HttpMessage\CookieInterface $cookie The cookie instance to add
     *
     * @return void
     */
    public function addCookie(CookieInterface $cookie)
    {
        $this->getResponse()->addCookie($cookie);
    }

    /**
     * Returns TRUE if the response already has a cookie with the passed
     * name, else FALSE.
     *
     * @param string $cookieName Name of the cookie to be checked
     *
     * @return boolean TRUE if the response already has the cookie, else FALSE
     */
    public function hasCookie($cookieName)
    {
        return $this->getResponse()->hasCookie($cookieName);
    }

    /**
     * Returns the cookie with the  a cookie
     *
     * @param string $cookieName Name of the cookie to be checked
     *
     * @return \AppserverIo\Psr\HttpMessage\CookieInterface $cookie The cookie instance
     */
    public function getCookie($cookieName)
    {
        return $this->getResponse()->getCookie($cookieName);
    }

    /**
     * Sets the headers
     *
     * @param array $headers The headers array
     *
     * @return void
     */
    public function setHeaders(array $headers)
    {
        $this->getResponse()->setHeaders($headers);
    }

    /**
     * Returns the headers array
     *
     * @return array
     */
    public function getHeaders()
    {
        return $this->getResponse()->getHeaders();
    }

    /**
     * Adds a header to array
     *
     * @param string     $header The header label e.g. Accept or Content-Length
     * @param string|int $value  The header value
     *
     * @return void
     */
    public function addHeader($header, $value)
    {
        $this->getResponse()->addHeader($header, $value);
    }

    /**
     * Returns header info by given key
     *
     * @param string $key The headers key to return
     *
     * @return string|null
     */
    public function getHeader($key)
    {
        return $this->getResponse()->getHeader($key);
    }

    /**
     * Returns the headers as string
     *
     * @return string
     */
    public function getHeadersAsString()
    {
        return $this->getResponse()->getHeadersAsString();
    }

    /**
     * Removes one single header from the headers array.
     *
     * @param string $header The header to remove
     *
     * @return void
     */
    public function removeHeader($header)
    {
        $this->getResponse()->removeHeader($header);
    }

    /**
     * Checks if header exists by given name.
     *
     * @param string $name The header name to check
     *
     * @return boolean TRUE if the header is available, else FALSE
     */
    public function hasHeader($name)
    {
        return $this->getResponse()->hasHeader($name);
    }

    /**
     * Returns the response that will be send back to the client.
     *
     * @return \AppserverIo\Psr\Servlet\Http\HttpServletResponseInterface The response instance
     */
    public function getResponse()
    {
        return $this->response;
    }

    /**
     * Returns Http response code number only.
     *
     * @return string
     */
    public function getStatusCode()
    {
        return $this->getResponse()->getStatusCode();
    }

    /**
     * Gets the response Reason-Phrase, a short textual description of the
     * Status-Code.
     *
     * Because a Reason-Phrase is not a required element in response
     * Status-Line, the Reason-Phrase value MAY be null. Implementations MAY
     * choose to return the default RFC 2616 recommended reason phrase for the
     * response's Status-Code.
     *
     * @return string|null Reason phrase, or null if unknown.
     */
    public function getStatusReasonPhrase()
    {
        return $this->getResponse()->getStatusReasonPhrase();
    }

    /**
     * Returns response Http version.
     *
     * @return string
     */
    public function getVersion()
    {
        return $this->getResponse()->getVersion();
    }

    /**
     * Reset the body stream.
     *
     * @return void
     */
    public function resetBodyStream()
    {
        $this->getResponse()->resetBodyStream();
    }

    /**
     * Sets the HTTP response status code.
     *
     * @param integer $code The HTTP status code to set
     *
     * @return void
     */
    public function setStatusCode($code)
    {
        $this->getResponse()->setStatusCode($code);
    }

    /**
     * Appends the content.
     *
     * @param string $content The content to append
     *
     * @return void
     */
    public function appendBodyStream($content)
    {
        $this->getResponse()->appendBodyStream($content);
    }

    /**
     * Copies a source stream to body stream.
     *
     * @param resource $sourceStream The file pointer to source stream
     * @param integer  $maxlength    The max length to read from source stream
     * @param integer  $offset       The offset from source stream to read
     *
     * @return integer The total number of bytes copied
     */
    public function copyBodyStream($sourceStream, $maxlength = null, $offset = 0)
    {
        return $this->getResponse()->copyBodyStream($sourceStream, $maxlength, $offset);
    }

    /**
     * Returns the body content.
     *
     * @return string The boda content
     */
    public function getBodyContent()
    {
        return $this->getResponse()->getBodyContent();
    }

    /**
     * Returns the body stream as a resource.
     *
     * @return resource The body stream
     */
    public function getBodyStream()
    {
        return $this->getResponse()->getBodyStream();
    }

    /**
     * Returns the cookies.
     *
     * @return array The cookies
     */
    public function getCookies()
    {
        return $this->getResponse()->getCookies();
    }

    /**
     * Returns the exception bound to the response.
     *
     * @return \Exception|null The exception
     */
    public function getException()
    {
        return $this->getResponse()->getException();
    }

    /**
     * Returns the current state
     *
     * @return int
     */
    public function getState()
    {
        return $this->getResponse()->getState();
    }

    /**
     * Queries whether the response contains an exception or not.
     *
     * @return boolean TRUE if an exception has been attached, else FALSE
     */
    public function hasException()
    {
        return $this->getResponse()->hasException();
    }

    /**
     * Compares current state with given state
     *
     * @param int $state The state to compare with
     *
     * @return bool Whether state is equal (true) or not (false)
     */
    public function hasState($state)
    {
        return $this->getResponse()->hasState($state);
    }

    /**
     * Redirects to the passed URL by adding a 'Location' header and
     * setting the appropriate status code, by default 301.
     *
     * @param string  $url  The URL to forward to
     * @param integer $code The status code to set
     *
     * @return void
     */
    public function redirect($url, $code = 301)
    {
        $this->getResponse()->redirect($url, $code);
    }

    /**
     * Resetss the stream resource pointing to body content.
     *
     * @param resource $bodyStream The body content stream resource
     *
     * @return void
     */
    public function setBodyStream($bodyStream)
    {
        $this->getResponse()->setBodyStream($bodyStream);
    }

    /**
     * Binds the exception to the response.
     *
     * @param \Exception $exception The exception to bind.
     *
     * @return void
     */
    public function setException(\Exception $exception)
    {
        $this->getResponse()->setException($exception);
    }

    /**
     * Sets state of response
     *
     * @param int $state The state value
     *
     * @return void
     */
    public function setState($state)
    {
        $this->getResponse()->setState($state);
    }

    /**
     * Sets the status reason phrase
     *
     * @param string $statusReasonPhrase The reason phrase
     *
     * @return void
     */
    public function setStatusReasonPhrase($statusReasonPhrase)
    {
        $this->getResponse()->setStatusReasonPhrase($statusReasonPhrase);
    }
}