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