includes/libs/HtmlArmor.php

   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@member.fsf.org>
  21  */
  22
  23 /**
  24  * Marks HTML that shouldn't be escaped
  25  *
  26  * @since 1.28
  27  */
  28 class HtmlArmor {
  29
  30         /**
  31          * @var string|null
  32          */
  33         private $value;
  34
  35         /**
  36          * @param string|null $value
  37          */
  38         public function __construct( $value ) {
  39                 $this->value = $value;
  40         }
  41
  42         /**
  43          * Provide a string or HtmlArmor object
  44          * and get safe HTML back
  45          *
  46          * @param string|HtmlArmor $input
  47          * @return string|null safe for usage in HTML, or null
  48          *         if the HtmlArmor instance was wrapping null.
  49          */
  50         public static function getHtml( $input ) {
  51                 if ( $input instanceof HtmlArmor ) {
  52                         return $input->value;
  53                 } else {
  54                         return htmlspecialchars( $input, ENT_QUOTES );
  55                 }
  56         }
  57 }