Source: /textpattern/vendors/Textpattern/Textfilter/TextfilterInterface.php - 65 lines - 1567 bytes - Summary - Text - Print

Description: Textfilter interface.

   1  <?php
   2  
   3  /*
   4   * Textpattern Content Management System
   5   * https://textpattern.com/
   6   *
   7   * Copyright (C) 2020 The Textpattern Development Team
   8   *
   9   * This file is part of Textpattern.
  10   *
  11   * Textpattern is free software; you can redistribute it and/or
  12   * modify it under the terms of the GNU General Public License
  13   * as published by the Free Software Foundation, version 2.
  14   *
  15   * Textpattern is distributed in the hope that it will be useful,
  16   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18   * GNU General Public License for more details.
  19   *
  20   * You should have received a copy of the GNU General Public License
  21   * along with Textpattern. If not, see <https://www.gnu.org/licenses/>.
  22   */
  23  
  24  /**
  25   * Textfilter interface.
  26   *
  27   * This is an interface for creating Textfilters.
  28   *
  29   * @since   4.6.0
  30   * @package Textfilter
  31   */
  32  
  33  namespace Textpattern\Textfilter;
  34  
  35  interface TextfilterInterface
  36  {
  37      /**
  38       * Filters the given raw input value.
  39       *
  40       * @param  string $thing   The raw input string
  41       * @param  array  $options Options
  42       * @return string Filtered output text
  43       */
  44  
  45      public function filter($thing, $options);
  46  
  47      /**
  48       * Gets filter-specific help.
  49       *
  50       * A help URL containing usage information that will be
  51       * presented to the user.
  52       *
  53       * @return string Filter-specific help
  54       */
  55  
  56      public function getHelp();
  57  
  58      /**
  59       * Gets a filter's globally unique identifier.
  60       *
  61       * @return string
  62       */
  63  
  64      public function getKey();
  65  }