HtmlArmor.php 1.5 KB

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