Syscodes\Components\Http\Resources\HttpResponse

Complexity

Total Complexity

7

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	withException()	0	5	1
A	setProtocolVersion()	0	3	1
A	throwResponse()	0	3	1
A	header()	0	5	1
A	status()	0	3	1
A	content()	0	3	1
A	getProtocolVersion()	0	3	1

<?php

/**
 * Lenevor Framework
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file license.md.
 * It is also available through the world-wide-web at this URL:
 * https://lenevor.com/license
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@Lenevor.com so we can send you a copy immediately.
 *
 * @package     Lenevor
 * @subpackage  Base
 * @link        https://lenevor.com
 * @copyright   Copyright (c) 2019 - 2023 Alexander Campo <jalexcam@gmail.com>
 * @license     https://opensource.org/licenses/BSD-3-Clause New BSD license or see https://lenevor.com/license or see /license.md
 */

namespace Syscodes\Components\Http\Resources;

use Throwable;
use Syscodes\Components\Http\Exceptions\HttpResponseException;

/**
 * Loads the response trait of headers, status code and content message.
 */
trait HttpResponse
{
    /**
     * The content of the response.
     * 
     * @var string $content
     */
    protected $content = null;
    
    /**
     * The exception that triggered the error response (if applicable).
     * 
     * @var \Exception|null $exception
     */
    protected $exception;

    /**
     * The Headers class instance.
     * 
     * @var \Syscodes\Components\Http\ResponseHeaders $headers
     */
	public $headers;

    /**
     * The HTTP protocol version.
     * 
     * @var string $version
     */
    protected $version;

    /**
     * Gets the content of the response.
     * 
     * @return string
     */
    public function content(): string
    {
        return $this->getContent();

It seems like getContent() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Gets the status code for the response.
     * 
     * @return int
     */
    public function status(): int
    {
        return $this->getStatusCode();

It seems like getStatusCode() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Sets a header on the response.
     * 
     * @param  string  $key  The header name
     * @param  string  $values  The value or an array of values
     * @param  bool  $replace  If you want to replace the value exists by the header
     * 
     * @return static
     */
    public function header($key, $values, $replace = true): static
    {
        $this->headers->set($key, $values, $replace);

        return $this;
    }

    /**
     * Gets the Http protocol version.
     * 
     * @return string
     */
    public function getProtocolVersion(): string
    {
        return $this->version;
    }

    /**
     * Sets the Http protocol version.
     * 
     * @return string
     */
    public function setProtocolVersion(string $version): void
    {
        $this->version = $version;
    }

    /**
     * Sets the exception to the response.
     * 
     * @param  \Throwable  $e
     * 
     * @return static
     */
    public function withException(Throwable $e): static
    {
        $this->exception = $e;

$e is of type Throwable, but the property $exception was declared to be of type Exception|null. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

        return $this;
    }

    /**
     * Throws the response in a HttpResponseException instance.
     * 
     * @throws \Syscodes\Components\Http\Exceptions\HttpResponseException
     */
    public function throwResponse()
    {
        throw new HttpResponseException($this);
    }
}