summaryrefslogtreecommitdiff
path: root/app/Html.php
blob: a0ec39b38a95c288dbad9279bf675b1eb53f0ca9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
<?php
/**
 * webtrees: online genealogy
 * Copyright (C) 2018 webtrees development team
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
namespace Fisharebest\Webtrees;

/**
 * Class Html - Add HTML markup to elements consistently.
 */
class Html
{
    /**
     * Escape a string for inclusion within HTML.
     *
     * @param $string
     *
     * @return string
     */
    public static function escape($string)
    {
        return htmlspecialchars($string, ENT_QUOTES | ENT_SUBSTITUTE, 'UTF-8');
    }

    /**
     * Convert an array of HTML attributes to an HTML string.
     *
     * @param array $attributes
     *
     * @return string
     */
    public static function attributes(array $attributes)
    {
        $html = [];
        foreach ($attributes as $key => $value) {
            if (is_string($value) || is_integer($value)) {
                $html[] = self::escape($key) . '="' . self::escape($value) . '"';
            } elseif ($value !== false) {
                $html[] = self::escape($key);
            }
        }

        return implode(' ', $html);
    }

    /**
     * Encode a URL.
     *
     * @param string $path
     * @param array  $data
     *
     * @return string
     */
    public static function url($path, array $data)
    {
        $path = strtr($path, ' ', '%20');

        return $path . '?' . http_build_query($data, '', '&', PHP_QUERY_RFC3986);
    }

    /**
     * Filenames are (almost?) always LTR, even on RTL systems.
     *
     * @param string $filename
     *
     * @return string
     */
    public static function filename($filename)
    {
        return '<samp class="filename" dir="ltr">' . self::escape($filename) . '</samp>';
    }
}