[Summary view] [Print] [Text view]

   1  <?php declare(strict_types=1);
   2  
   3  /**
   4  * @package   s9e\TextFormatter
   5  * @copyright Copyright (c) 2010-2022 The s9e authors
   6  * @license   http://www.opensource.org/licenses/mit-license.php The MIT License
   7  */
   8  namespace s9e\TextFormatter\Configurator\RecursiveParser;
   9  
  10  interface MatcherInterface
  11  {
  12      /**
  13      * Return the matchers configuration
  14      *
  15      * Match name as key. Can be prefixed with a colon-separated list of groups, e.g. "Group:Name".
  16      * Value must be a string or an array with the following elements:
  17      *
  18      *  - regexp:   the regular expression used to match input.
  19      *  - order:    used to sort matchers. Defaults to 0.
  20      *  - groups:   list of groups this match belongs to. Defaults to an empty array.
  21      *  - callback: called with the matched strings. Defaults to [$this, "parseX"] where X is the
  22      *              match name.
  23      *
  24      * If the config is a string, the string is used for the "regexp" element.
  25      *
  26      * @return array
  27      */
  28  	public function getMatchers(): array;
  29  }