xref: /webtrees/app/Http/ViewResponseTrait.php (revision 3976b4703df669696105ed6b024b96d433c8fbdb)
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2019 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17declare(strict_types=1);
18
19namespace Fisharebest\Webtrees\Http;
20
21use Fig\Http\Message\StatusCodeInterface;
22use Psr\Http\Message\ResponseInterface;
23
24use function response;
25use function view;
26
27/**
28 * Allows a page fragment to be embedded in a page layout and converted to an HTTP response.
29 * Used by controllers, request-handlers, modules, etc.
30 */
31trait ViewResponseTrait
32{
33    protected $layout = 'layouts/default';
34
35    /**
36     * @param string  $view_name
37     * @param mixed[] $view_data
38     * @param int     $status
39     *
40     * @return ResponseInterface
41     */
42    protected function viewResponse(string $view_name, array $view_data, $status = StatusCodeInterface::STATUS_OK): ResponseInterface
43    {
44        // Make the view's data available to the layout.
45        $layout_data = $view_data;
46
47        // Render the view
48        $layout_data['content'] = view($view_name, $view_data);
49
50        // Most pages use the default layout.  Other built-in layouts include admin and ajax.
51        $layout = $this->layout;
52
53        // Insert the view into the layout
54        $html = view($layout, $layout_data);
55
56        return response($html, $status);
57    }
58}
59