File: AttributeValueInterface.php

package info (click to toggle)
php-twig 3.24.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,620 kB
  • sloc: php: 26,096; makefile: 123; sh: 43
file content (31 lines) | stat: -rw-r--r-- 834 bytes parent folder | download
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
<?php

/*
 * This file is part of Twig.
 *
 * (c) Fabien Potencier
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Twig\Extra\Html\HtmlAttr;

/**
 * Interface for custom attribute value objects.
 *
 * Implement this interface to create custom conversion logic when printing out objects as attribute
 * values in the `html_attr` function.
 *
 * @author Matthias Pigulla <mp@webfactory.de>
 */
interface AttributeValueInterface
{
    /**
     * Returns the string representation of the attribute value. The returned value
     * will automatically be escaped for the HTML attribute context.
     *
     * @return string|null the attribute value as a string, or null to omit the attribute
     */
    public function getValue(): ?string;
}