[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /**
   4   * Joomla! Content Management System
   5   *
   6   * @copyright  (C) 2019 Open Source Matters, Inc. <https://www.joomla.org>
   7   * @license    GNU General Public License version 2 or later; see LICENSE.txt
   8   */
   9  
  10  namespace Joomla\CMS\Form\Filter;
  11  
  12  use Joomla\CMS\Filter\InputFilter;
  13  use Joomla\CMS\Form\Form;
  14  use Joomla\CMS\Form\FormFilterInterface;
  15  use Joomla\Registry\Registry;
  16  
  17  // phpcs:disable PSR1.Files.SideEffects
  18  \defined('JPATH_PLATFORM') or die;
  19  // phpcs:enable PSR1.Files.SideEffects
  20  
  21  /**
  22   * Form Filter class for safe HTML
  23   *
  24   * @since  4.0.0
  25   */
  26  class SafehtmlFilter implements FormFilterInterface
  27  {
  28      /**
  29       * Method to filter a field value.
  30       *
  31       * @param   \SimpleXMLElement  $element  The SimpleXMLElement object representing the `<field>` tag for the form field object.
  32       * @param   mixed              $value    The form field value to validate.
  33       * @param   string             $group    The field name group control value. This acts as an array container for the field.
  34       *                                       For example if the field has name="foo" and the group value is set to "bar" then the
  35       *                                       full field name would end up being "bar[foo]".
  36       * @param   Registry           $input    An optional Registry object with the entire data set to validate against the entire form.
  37       * @param   Form               $form     The form object for which the field is being tested.
  38       *
  39       * @return  mixed   The filtered value.
  40       *
  41       * @since   4.0.0
  42       */
  43      public function filter(\SimpleXMLElement $element, $value, $group = null, Registry $input = null, Form $form = null)
  44      {
  45          return InputFilter::getInstance(
  46              [],
  47              [],
  48              InputFilter::ONLY_BLOCK_DEFINED_TAGS,
  49              InputFilter::ONLY_BLOCK_DEFINED_ATTRIBUTES
  50          )->clean($value, 'html');
  51      }
  52  }