Yiisoft\ErrorHandler\ErrorData

Complexity

Total Complexity

4

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__toString()	0	3	1
A	addToResponse()	0	8	2

<?php

declare(strict_types=1);

namespace Yiisoft\ErrorHandler;

use Psr\Http\Message\ResponseInterface;

/**
 * ErrorData stores content and headers that are suitable for adding to response.
 */
final class ErrorData
{
    /**
     * @var string The content to use as response body.
     */
    private string $content;

    /**
     * @var array<string, string|string[]> The headers to add to the response.
     */
    private array $headers;

    /**
     * @param string $content The content to use as response body.
     * @param array<string, string|string[]> $headers The headers to add to the response.
     */
    public function __construct(string $content, array $headers = [])
    {
        $this->content = $content;
        $this->headers = $headers;
    }

    /**
     * Returns a content to use as response body.
     *
     * @return string The content to use as response body.
     */
    public function __toString(): string
    {
        return $this->content;
    }

    /**
     * Returns a response with error data.
     *
     * @param ResponseInterface $response The response for setting error data.
     *
     * @return ResponseInterface The response with error data.
     */
    public function addToResponse(ResponseInterface $response): ResponseInterface
    {
        foreach ($this->headers as $name => $value) {
            $response = $response->withHeader($name, $value);
        }

        $response->getBody()->write($this->content);
        return $response;
    }
}