summaryrefslogtreecommitdiffstats
path: root/vendor/ipl/html/src/Attribute.php
blob: 0cf13b812dba5bd7d1590214f55e683075125bbb (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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<?php

namespace ipl\Html;

use InvalidArgumentException;

/**
 * HTML Attribute
 *
 * Every single HTML attribute is (or should be) an instance of this class.
 * This guarantees that every attribute is safe and escaped correctly.
 *
 * Usually attributes are not instantiated directly, but created through an HTML
 * element's exposed methods.
 */
class Attribute
{
    /** @var string */
    protected $name;

    /** @var string|array|bool|null */
    protected $value;

    /**
     * Create a new HTML attribute from the given name and value
     *
     * @param string                 $name  The name of the attribute
     * @param string|bool|array|null $value The value of the attribute
     *
     * @throws InvalidArgumentException If the name of the attribute contains special characters
     */
    public function __construct($name, $value = null)
    {
        $this->setName($name)->setValue($value);
    }

    /**
     * Create a new HTML attribute from the given name and value
     *
     * @param string                 $name  The name of the attribute
     * @param string|bool|array|null $value The value of the attribute
     *
     * @return static
     *
     * @throws InvalidArgumentException If the name of the attribute contains special characters
     */
    public static function create($name, $value)
    {
        return new static($name, $value);
    }

    /**
     * Create a new empty HTML attribute from the given name
     *
     * The value of the attribute will be null after construction.
     *
     * @param string $name The name of the attribute
     *
     * @return static
     *
     * @throws InvalidArgumentException If the name of the attribute contains special characters
     */
    public static function createEmpty($name)
    {
        return new static($name, null);
    }

    /**
     * Escape the name of an attribute
     *
     * Makes sure that the name of an attribute really is a string.
     *
     * @param string $name
     *
     * @return string
     */
    public static function escapeName($name)
    {
        return (string) $name;
    }

    /**
     * Escape the value of an attribute
     *
     * If the value is an array, returns the string representation
     * of all array elements joined with the specified glue string.
     *
     * Values are escaped according to the HTML5 double-quoted attribute value syntax:
     * {@link https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 }.
     *
     * @param string|array $value
     * @param string       $glue Glue string to join elements if value is an array
     *
     * @return string
     */
    public static function escapeValue($value, $glue = ' ')
    {
        if (is_array($value)) {
            $value = implode($glue, $value);
        }

        // We force double-quoted attribute value syntax so let's start by escaping double quotes
        $value = str_replace('"', '&quot;', $value);

        // In addition, values must not contain ambiguous ampersands
        $value = preg_replace_callback(
            '/&[0-9A-Z]+;/i',
            function ($match) {
                $subject = $match[0];

                if (htmlspecialchars_decode($subject, ENT_COMPAT | ENT_HTML5) === $subject) {
                    // Ambiguous ampersand
                    return str_replace('&', '&amp;', $subject);
                }

                return $subject;
            },
            $value
        );

        return $value;
    }

    /**
     * Get the name of the attribute
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Set the name of the attribute
     *
     * @param string $name
     *
     * @return $this
     *
     * @throws InvalidArgumentException If the name contains special characters
     */
    protected function setName($name)
    {
        if (! preg_match('/^[a-z][a-z0-9:-]*$/i', $name)) {
            throw new InvalidArgumentException(sprintf(
                'Attribute names with special characters are not yet allowed: %s',
                $name
            ));
        }

        $this->name = $name;

        return $this;
    }

    /**
     * Get the value of the attribute
     *
     * @return string|bool|array|null
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Set the value of the attribute
     *
     * @param string|bool|array|null $value
     *
     * @return $this
     */
    public function setValue($value)
    {
        $this->value = $value;

        return $this;
    }

    /**
     * Add the given value(s) to the attribute
     *
     * @param string|array $value The value(s) to add
     *
     * @return $this
     */
    public function addValue($value)
    {
        $this->value = array_merge((array) $this->value, (array) $value);

        return $this;
    }

    /**
     * Remove the given value(s) from the attribute
     *
     * The current value is set to null if it matches the value to remove
     * or is in the array of values to remove.
     *
     * If the current value is an array, all elements are removed which
     * match the value(s) to remove.
     *
     * Does nothing if there is no such value to remove.
     *
     * @param string|array $value The value(s) to remove
     *
     * @return $this
     */
    public function removeValue($value)
    {
        $value = (array) $value;

        $current = $this->getValue();

        if (is_array($current)) {
            $this->setValue(array_diff($current, $value));
        } elseif (in_array($current, $value, true)) {
            $this->setValue(null);
        }

        return $this;
    }

    /**
     * Test and return true if the attribute is boolean, false otherwise
     *
     * @return bool
     */
    public function isBoolean()
    {
        return is_bool($this->value);
    }

    /**
     * Test and return true if the attribute is empty, false otherwise
     *
     * Null and the empty array will be considered empty.
     *
     * @return bool
     */
    public function isEmpty()
    {
        return $this->value === null || $this->value === [];
    }

    /**
     * Render the attribute to HTML
     *
     * If the value of the attribute is of type boolean, it will be rendered as
     * {@link http://www.w3.org/TR/html5/infrastructure.html#boolean-attributes boolean attribute}.
     * Note that in this case if the value of the attribute is false, the empty string will be returned.
     *
     * If the value of the attribute is null or an empty array,
     * the empty string will be returned as well.
     *
     * Escaping of the attribute's value takes place automatically using {@link Attribute::escapeValue()}.
     *
     * @return string
     */
    public function render()
    {
        if ($this->isEmpty()) {
            return '';
        }

        if ($this->isBoolean()) {
            if ($this->value) {
                return $this->renderName();
            }

            return '';
        } else {
            return sprintf(
                '%s="%s"',
                $this->renderName(),
                $this->renderValue()
            );
        }
    }

    /**
     * Render the name of the attribute to HTML
     *
     * @return string
     */
    public function renderName()
    {
        return static::escapeName($this->name);
    }

    /**
     * Render the value of the attribute to HTML
     *
     * @return string
     */
    public function renderValue()
    {
        return static::escapeValue($this->value);
    }
}