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