php-api-problems/src/ApiProblem/ApiProblemResponse.php at e30a66278463b6f214792a23ede14035d1f3aefb · nilportugues/php-api-problems · GitHub

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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
<?php
/**
 * Author: Nil Portugués Calderó <contact@nilportugues.com>
 * Date: 8/03/16
 * Time: 23:34.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace NilPortugues\Api\Problem;

use Exception;
use GuzzleHttp\Psr7\Response;
use NilPortugues\Api\Problem\Presenter\JsonPresenter;
use NilPortugues\Api\Problem\Presenter\Presenter;
use NilPortugues\Api\Problem\Presenter\XmlPresenter;

class ApiProblemResponse extends Response
{
    /**
     * ApiProblemResponse constructor.
     *
     * @param Presenter $presenter
     */
    public function __construct(Presenter $presenter)
    {
        parent::__construct(
            $presenter->apiProblem()->status(),
            ['Content-type' => $this->responseHeader($presenter)],
            $presenter->contents()
        );
    }

    /**
     * @param Presenter $presenter
     *
     * @return string
     */
    protected function responseHeader(Presenter $presenter)
    {
        return ($presenter->format() === 'xml') ? 'application/problem+xml' : 'application/problem+json';
    }

    /**
     * @param $status
     * @param $detail
     * @param string $title
     * @param string $type
     * @param array  $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function json($status, $detail, $title = '', $type = '', array $additionalDetails = [])
    {
        return new self(new JsonPresenter(new ApiProblem($status, $detail, $title, $type, $additionalDetails)));
    }

    /**
     * @param Exception $exception
     * @param string    $title
     * @param string    $type
     * @param array     $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function fromExceptionToJson(
        Exception $exception,
        $title = '',
        $type = '',
        array $additionalDetails = []
    ) {
        return new self(new JsonPresenter(ApiProblem::fromException($exception, $title, $type, $additionalDetails)));
    }

    /**
     * @param Throwable $throwable
     * @param string    $title
     * @param string    $type
     * @param array     $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function froThrowableToJson(
        Throwable $throwable,
        $title = '',
        $type = '',
        array $additionalDetails = []
    ) {
        return new self(new JsonPresenter(ApiProblem::fromThrowable($throwable, $title, $type, $additionalDetails)));
    }

    /**
     * @param $status
     * @param $detail
     * @param string $title
     * @param string $type
     * @param array  $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function xml($status, $detail, $title = '', $type = '', array $additionalDetails = [])
    {
        return new self(new XmlPresenter(new ApiProblem($status, $detail, $title, $type, $additionalDetails)));
    }

    /**
     * @param Exception $exception
     * @param string    $title
     * @param string    $type
     * @param array     $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function fromExceptionToXml(
        Exception $exception,
        $title = '',
        $type = '',
        array $additionalDetails = []
    ) {
        return new self(new XmlPresenter(ApiProblem::fromException($exception, $title, $type, $additionalDetails)));
    }

    /**
     * @param Throwable $throwable
     * @param string    $title
     * @param string    $type
     * @param array     $additionalDetails
     *
     * @return ApiProblemResponse
     */
    public static function fromThroableToXml(
        Throwable $throwable,
        $title = '',
        $type = '',
        array $additionalDetails = []
    ) {
        return new self(new XmlPresenter(ApiProblem::fromThrowable($throwable, $title, $type, $additionalDetails)));
    }
}