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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Factories;
use Fig\Http\Message\StatusCodeInterface;
use Fisharebest\Webtrees\Contracts\ResponseFactoryInterface;
use Fisharebest\Webtrees\Module\ModuleThemeInterface;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Webtrees;
use Psr\Http\Message\ResponseFactoryInterface as PSR17ResponseFactoryInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\StreamFactoryInterface;
use Psr\Http\Message\UriInterface;
use function is_string;
use function json_encode;
use function view;
use const JSON_THROW_ON_ERROR;
use const JSON_UNESCAPED_UNICODE;
/**
* Make a PSR-7 response (using a PSR-17 response factory).
*/
class ResponseFactory implements ResponseFactoryInterface
{
private PSR17ResponseFactoryInterface $response_factory;
private StreamFactoryInterface $stream_factory;
/**
* @param PSR17ResponseFactoryInterface $response_factory
* @param StreamFactoryInterface $stream_factory
*/
public function __construct(PSR17ResponseFactoryInterface $response_factory, StreamFactoryInterface $stream_factory)
{
$this->response_factory = $response_factory;
$this->stream_factory = $stream_factory;
}
/**
* Redirect to a named route.
*
* @param string $route_name
* @param array<bool|int|string|array<string>|null> $parameters
* @param int $status
*
* @return ResponseInterface
*
*/
public function redirect(
string $route_name,
array $parameters = [],
int $status = StatusCodeInterface::STATUS_FOUND
): ResponseInterface {
$url = Registry::routeFactory()->route($route_name, $parameters);
return $this->redirectUrl($url, $status);
}
/**
* Redirect to a URL.
*
* @param UriInterface|string $url
* @param int $code
*
* @return ResponseInterface
*/
public function redirectUrl(UriInterface|string $url, int $code = StatusCodeInterface::STATUS_FOUND): ResponseInterface
{
return $this->response_factory
->createResponse($code)
->withHeader('location', (string) $url);
}
/**
* @param string|array<mixed>|object $content
* @param int $code
* @param array<string,string> $headers
*
* @return ResponseInterface
*/
public function response(string|array|object $content = '', int $code = StatusCodeInterface::STATUS_OK, array $headers = []): ResponseInterface
{
if ($content === '' && $code === StatusCodeInterface::STATUS_OK) {
$code = StatusCodeInterface::STATUS_NO_CONTENT;
}
if (is_string($content)) {
$headers['content-type'] ??= 'text/html; charset=UTF-8';
} else {
$content = json_encode($content, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE);
$headers['content-type'] ??= 'application/json';
}
$stream = $this->stream_factory->createStream($content);
$response = $this->response_factory
->createResponse($code)
->withBody($stream);
foreach ($headers as $key => $value) {
$response = $response->withHeader($key, $value);
}
return $response;
}
/**
* Create and render a view, and embed it in an HTML page.
*
* @param string $view_name
* @param array<string,mixed> $view_data
* @param int $status
* @param string $layout_name
*
* @return ResponseInterface
*/
public function view(
string $view_name,
array $view_data,
int $status = StatusCodeInterface::STATUS_OK,
string $layout_name = Webtrees::LAYOUT_DEFAULT
): ResponseInterface {
// Render the view.
$content = view($view_name, $view_data);
// Make the view's data available to the layout.
$layout_data = [
'content' => $content,
'request' => Registry::container()->get(ServerRequestInterface::class),
'theme' => Registry::container()->get(ModuleThemeInterface::class),
'title' => $view_data['title'] ?? Webtrees::NAME,
];
// Embed the content in the layout.
$html = view($layout_name, $layout_data);
return $this->response($html, $status);
}
}
|
