xref: /webtrees/app/Http/ViewResponseTrait.php (revision fcfa147e10aaa6c7ff580c29bd6e5b88666befc1)
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 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Http;
21
22use Fig\Http\Message\StatusCodeInterface;
23use Psr\Http\Message\ResponseInterface;
24
25use function response;
26use function view;
27
28/**
29 * Allows a page fragment to be embedded in a page layout and converted to an HTTP response.
30 * Used by controllers, request-handlers, modules, etc.
31 */
32trait ViewResponseTrait
33{
34    protected $layout = 'layouts/default';
35
36    /**
37     * @param string  $view_name
38     * @param mixed[] $view_data
39     * @param int     $status
40     *
41     * @return ResponseInterface
42     */
43    protected function viewResponse(string $view_name, array $view_data, $status = StatusCodeInterface::STATUS_OK): ResponseInterface
44    {
45        // Make the view's data available to the layout.
46        $layout_data = $view_data;
47
48        // Render the view
49        $layout_data['content'] = view($view_name, $view_data);
50
51        // Most pages use the default layout.  Other built-in layouts include admin and ajax.
52        $layout = $this->layout;
53
54        // Insert the view into the layout
55        $html = view($layout, $layout_data);
56
57        return response($html, $status);
58    }
59}
60