CRM/Core/HTMLInputCoder.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  * Class CRM_Core_HTMLInputCoder
  30  */
  31 class CRM_Core_HTMLInputCoder {
  32
  33   /**
  34    * @param string $fldName
  35    * @return bool
  36    *   TRUE if encoding should be skipped for this field
  37    */
  38   public static function isSkippedField($fldName) {
  39     return CRM_Utils_API_HTMLInputCoder::singleton()->isSkippedField($fldName);
  40   }
  41
  42   /**
  43    * going to filter the
  44    * submitted values across XSS vulnerability.
  45    *
  46    * @param array|string $values
  47    * @param bool $castToString
  48    *   If TRUE, all scalars will be filtered (and therefore cast to strings).
  49    *    If FALSE, then non-string values will be preserved
  50    */
  51   public static function encodeInput(&$values, $castToString = TRUE) {
  52     return CRM_Utils_API_HTMLInputCoder::singleton()->encodeInput($values, $castToString);
  53   }
  54
  55 }