xref: /webtrees/app/Helpers/functions.php (revision 7bec14ac5948ab6ff50ff9495e5b8e649b30efe3)
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2017 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
18use Fisharebest\Webtrees\Filter;
19use Fisharebest\Webtrees\Html;
20
21/**
22 * Generate a CSRF token form field.
23 *
24 * @return string
25 */
26function csrf_field() {
27	return '<input type="hidden" name="csrf" value="' . e(Filter::getCsrfToken()) . '">';
28}
29
30/**
31 * Escape a string for inclusion within HTML.
32 *
33 * @param $text
34 *
35 * @return string
36 */
37function e(string $text): string {
38	return Html::escape($text);
39}
40
41/**
42 * Generate a URL for a named route.
43 *
44 * @param string $route
45 * @param array  $parameters
46 *
47 * @return string
48 */
49function route(string $route, array $parameters = []): string {
50	$parameters = ['route' => $route] + $parameters;
51
52	return Html::url('index.php', $parameters);
53}
54