Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
100.00% |
4 / 4 |
|
100.00% |
2 / 2 |
CRAP | |
100.00% |
1 / 1 |
| HtmlArmor | |
100.00% |
4 / 4 |
|
100.00% |
2 / 2 |
3 | |
100.00% |
1 / 1 |
| __construct | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| getHtml | |
100.00% |
3 / 3 |
|
100.00% |
1 / 1 |
2 | |||
| 1 | <?php |
| 2 | /** |
| 3 | * This program is free software; you can redistribute it and/or modify |
| 4 | * it under the terms of the GNU General Public License as published by |
| 5 | * the Free Software Foundation; either version 2 of the License, or |
| 6 | * (at your option) any later version. |
| 7 | * |
| 8 | * This program is distributed in the hope that it will be useful, |
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 11 | * GNU General Public License for more details. |
| 12 | * |
| 13 | * You should have received a copy of the GNU General Public License along |
| 14 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 16 | * http://www.gnu.org/copyleft/gpl.html |
| 17 | * |
| 18 | * @file |
| 19 | * @license GPL-2.0-or-later |
| 20 | * @author Kunal Mehta <legoktm@debian.org> |
| 21 | */ |
| 22 | |
| 23 | /** |
| 24 | * Marks HTML that shouldn't be escaped |
| 25 | * |
| 26 | * @newable |
| 27 | * |
| 28 | * @since 1.28 |
| 29 | */ |
| 30 | class HtmlArmor { |
| 31 | |
| 32 | /** |
| 33 | * @var string|null |
| 34 | */ |
| 35 | private $value; |
| 36 | |
| 37 | /** |
| 38 | * @stable to call |
| 39 | * |
| 40 | * @param string|null $value |
| 41 | * @param-taint $value exec_html |
| 42 | */ |
| 43 | public function __construct( $value ) { |
| 44 | $this->value = $value; |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Provide a string or HtmlArmor object |
| 49 | * and get safe HTML back |
| 50 | * |
| 51 | * @param string|HtmlArmor $input |
| 52 | * @return string|null safe for usage in HTML, or null |
| 53 | * if the HtmlArmor instance was wrapping null. |
| 54 | */ |
| 55 | public static function getHtml( $input ) { |
| 56 | if ( $input instanceof HtmlArmor ) { |
| 57 | return $input->value; |
| 58 | } else { |
| 59 | return htmlspecialchars( $input, ENT_QUOTES ); |
| 60 | } |
| 61 | } |
| 62 | } |